I'd like to use Doxygen to document legacy code that's a mix of C and x86 assembly language. The assembly language is not inline, but in separate assembly-only files. What is the recommended way to deal with the assembly language portion? ...
Looking at questions like http://stackoverflow.com/questions/77726/xml-or-sqlite-when-to-drop-xml-for-a-database and http://stackoverflow.com/questions/44207/what-are-good-alternative-data-formats-to-xml it is clear that XML is something you best use for exchanging data between systems, organizations, and software programs. For internal...
Is there a way to document a member inline in .Net? Let me explain. Most tools that extract documentation from comments support some kind of inline documentation where you can add a brief after the member declaration. Something like: public static string MyField; /// <summary>Information about MyField.</summary> Is there a way to do t...
Is there some nice documentation for windows batch scripting I can download and refer to while offline? ...
So I print out my documents, manuals, references when I use them (ie, I don't start a project by printing everything out, but when I'm trying to understand how to program a peripheral I usually print out the relevant sections). Yes, I have dual monitors (although I'd certainly like more pixels and am excited by the new $200 22" 1920x108...
Where can I find the official documentation of OpenGL extensions? The base API is pretty well documented and a Google search for a function name returns multiple pages with the documentation text. Yet Googling an extension function usually doesn't return anything useful. What am I missing? ...
Hi All, I am a contractor for a small software firm, and am wondering what sort of documentation other contractors tend to create to make things easier for the guy that comes after them? My current contract is a semi-permanent position, but I'd like to leave everything in good condition for anyone else who has to work on parts of the sys...
Hi, Does anyone know any source of examples and templates for software requirements, build environment description and other kind of documentations that are common for software development? Thanks! ...
I've recently starting playing around with Tix in Python, and I'm distressed at the lack of Python documentation for it online. Both the tutorial and book have plenty of code examples in Tcl and none in Python. Googling has turned up no good Python docs. What do Tix users do for their Python documentation? Do they just learn to read ...
I'm trying to get a WPF development environment set up at home, using Visual C# Express 2008. I installed both it and the MSDN documentation for it, however it looks like the documentation doesn't include any WPF documentation. I was about to install the Windows Vista SDK, however it looks like that only includes the documentation for ....
Need a good template recommendation for an API document for C# application. I had used an IEEE template 2 years ago but can't remember the template name and wondering if anyone has good template recommendation for the same. Due to reasons beyond my control I have to do it as a word document ...
In the past I have used nexo.com to share documents with sales, marketing, PR, and technical people for a small startup. But I wonder if there is a better solution to allow different types of geo-graphically dispersed workers to get to a variety of uploaded documents. I don't want to have to build or host this myself, and free or cheap i...
I work as part of a team on an existing application that has no inline documentation, nor does it have technical documentation. As I've been working on various bug reports on the application, I've written a sort of breadcrumb trail for myself - bug numbers in various places so that the next developer can refer to that bug number to see ...
I would like to generate documentation for a RESTful web service API that is written in Python. Ideally it would look like Yahoo's RESTful web service docs. Does anyone have any ideas or references? ...
How do you approach writing documentation that both, future developers, and non-technical audiences will have to use? Do you write two separate documents, or try to write one with enough information for both groups? Any other ideas? What are the advantages of doing it your way? ...
TeX/LaTeX is great, I use it in many ways. Some of its advantages are: it uses text files, this way the input-files can be diffed and many tools exist to work with text it is very flexible it has a stable layout: if I change something at the start of the document, it doesn't affect other things at the end of the document it has many ex...
Does anyone know of an application (hosted or otherwise) that I could use to keep track of details for a number of web sites? I manage 50+ web sites that range from custom solutions to open source platforms (WordPress, Joomla). I started to write my own but wanted to see if there is anything out there already. Here are some of the fea...
I know, it is hard to document on the work you already do. Especially time-constraint project often miss good documentation. Do you or the team you work in have some tricks to create some project-documentation? What are your best-practices? ...
We have some MS Word files documenting troubleshooting steps for certain custom systems. Those documents use a convention to mark things like table names, class names, fields, etc in a certain font so that it stands out and the reader knows they were entered verbatim. However, these items are rarely spell-checker friendly. This is rea...
I'm preparing documentation for an open source project. My target audience are developers. Right now, I'm working on the API, porting and code design sections. Anyone has any tips on making documentation for developers? ...