documentation

Is there a tool to generate a sample application configuration by analyzing a ConfigurationSection type and its attributes?

I am working on an application that has a large set of configuration values, modelled and organized through the .NET configuration types from the System.Configuration namespace (i.e. ConfigurationSection, ConfigurationProperty, ConfigurationElement, etc...). Several values are required and may or may not have defaults, while others are ...

Looking for outsource worker for our documentation works

I am looking for someone to do the oursource work of correcting and enhancing our technical documents which is translated from Korean (our native language!) to English. However, I don't know where to start. Please let me know any guidance. Thanks in advance. ...

TFS vs SharePoint: what is the best location to store documentation?

Usually, business people keep their documents in the SharePoint portal. I am (as a developer) would rather keep them in TFS (or any other source code repository) closer to the source code. Also in the latest case I would make folders structure in way like "Src", "Doc", "Data" to keep everything more consistent. Could you please share wh...

Optional parameters in OpenERP field definitions

I couldn't find any documentation of the optional parameters that are available to all field types in OpenERP models, so I added what I knew to the fields documentation page. (Until the web site gets regenerated, you can see it in the documentation source.) There are a bunch of parameters that I don't understand, so I'd appreciate help...

What's a good markup language to write user manuals in?

Developers need to write some manuals. Word sucks so we're killing it as fast as possible. So, what are good tools that people actually use? I'm perfectly ok with, and prefer, some kind of markup. LateX is a bit over the top and IIRC, rather tricky to modify the output in. I've looked at Sphinx (seems nice, has nice PDF, and we use Py...

The YUI maze: How do I get my CSS minified?

What steps should I follow to be able to minify CSS from the command line (Windows or Solaris)? ...

Qt Documentation Standards

I am looking for some help regarding documenting code in Qt. For instance, when I am developing on the XNA platform I use XML notation with tags such as summary, params, etc. What does Qt have and what are some standards. In addition, I am looking for something that will work with documentation generating applications (such as Doxygen),...

Mind mapping software for a team

Hey everyone, I am looking for a collaborative map mind software that can be used by a development team. The basic requirement is, obviously, to be able to work together from different location on the same document - We can use Dropbox to sync or it could be an online service. Also, since we intend to use it both for documentation, iss...

Documenting Visual Basic 6.0 code

I have just recently been asked to document 10 years worth of VB6 development done by one person. It's been some time since I looked at VB6 code myself, so I'm basically wondering if anyone has any tips for how best to go about it. Is there any good software, free or not, which would do something similar to javadoc out there for VB6, t...

Do tools exist for pair programming with a developer and a domain expert?

I would like to know if any tools exist to enable pair programing activities between a developer and non developer expert in the related field. An example of such a tool could be an IDE plugin that would require a plain language description of functions/methods inline with their arguments. This plugin could then render a section of cod...

Creating end-user documentation - What tools exist in .NET?

I should preface this by saying that this post should almost surely be a community wiki, though I don't know how to set that up. If someone could change this I would really appreciate it. We're working on a product that is a web-based application. We'd like to get some conceptual user documentation integrated into the app, preferably ...

How To Navigate Boost

I was reading over Boost ConceptCheck today, and encountered this warning in the implementation page: This documentation is out-of-date; similar but newer implementation techniques are now used. This documentation also refers to components and protocols in the library's old interace such as BOOST_CLASS_REQUIRES and constraints() fun...

Easy to navigate online Python reference manual?

I'm looking for some reference pages for Python similar to PHP.net's documentation. i.e., something that provides a clear, simple list of all the classes and methods within a module that I can click to get more information, such as the arguments. Having descriptions below each class/method makes it harder to find what you're looking for....

Why Doesn't jQuery use JSDoc?

Or do they and it's just not in the source? I'd really to get something that will stop js-doc-toolkit from freaking out each time it parses jQuery. It also means I can't properly document any code using jQuery as a dependency without at least putting some boilerplate js-doc blocks, which fail to properly document jQuery's structure. Is t...

Where can I get a complete reference on Mac OS X's CoreWLAN?

Googling for CoreWLAN brings a mere 701 results -- Apple's own shallow reference isn't even there, at least not on the first pages. For instance, I would like to know what are the possible values of kCWScanKeyScanType when scanning for networks. Apple will only say it defaults to APScanTypeActive, but doesn't explain what that means or ...

ActionScript / Flash – Add ASDoc Documentation to Adobe Help?

is it possible to add ASDoc documentation to Adobe Help application? i've configured Adobe Help to show documentation off-line only, so there is a store of the official AS3 docs on my computer somewhere, but all i can find is a helpmap.txt (800+ kb). it would be very convenient to have access to all documentation via right-click > view...

Why magento does not provide Guide or Manual for developers?

Hello, Can anyone know why magento does not provide any manual or developer guide? All most all framework and CMS provides their official development manual But in the case of magento I did not found any official manual which is very surprising thing. Learning magento is hard because they are making this thing hard. Thanks ...

Diff file syntax

I am currently playing around with parsing diff files, and have yet to come across a solid documentation on diff files. I am especially interested in specifications. E.g. I don't really understand the lines that look like this (at the beginning of each changed code block): @@ -296,7 +296,8 @@ I know they have to do with line numbers,...

Where can I learn about CS Scrpit?

Hi, I have this piece of code: var arrayParamaters = sParameters["split"]("|"); I want to find a documentation that map the functions/variables of a cs script var. as in the example I treat the sParameters as an array, and I would like to know the functions I can use with it... Adam. ...