I was wondering if anyone could provide me some information on what they put in a requirements document, how do you structure it? I'm the lead for the first time ever and I want to make sure I provide good documents so the project will succeed. Any templates/examples would be great. ...
I'm revising an existing 60 page PDF document for a new product. I have to use MS-Word. Is there a good reference on the best practices for using Word? For instance, I've heard that it's best to keep everything in "sections". I'll be doing a TOC, lots of illustrations, multiple columns, etc. It's just going to be me revising it, so versi...
I'm a Mac developer with a very strong Java background. I've documented my sources using Javadoc, a lot. What's the way to go with Cocoa and Xcode? Are there any documentation tools supplied together with Apple's Developer Tools? Is Doxygen the way to go? What are the alternatives? Thank you all! ...
You are joining a project to maintain an existing system. There is no written documentation at all, but the previous team offers to write one piece of documentation. And they are going to let you decide what it should cover: What is the single most important piece of documentation? This is a poll: give only one document type per answer ...
Hi there. I was wondering what people use for Documentation and saw that this had already been asked here There seemed to be a lot of votes for LaTeX, I'm an advocate of LaTeX over Word due to its WYGIWYW (What You Get is What You Want) approach. However, its not easy to convince others to use it. I'm inertested to hear from anyone wh...
I ask because I am in need of some examples of spectacular documentation to do a little compare/contrast. Bad documentation abounds but who gets it stone cold correct? I suppose we should differentiate between documentation geared at informing experts and documentation geared at teaching new users but if you know of something that combi...
I am totally new to WPF and looking for good quickstart documentation to start with. I will buy the book WPF Unleashed from Adam Nathan, but thats more a reference than a quickstart i think. I just want you to tell me your favorite links and books and maybe demo applications concerning wpf development. Focus of answers should be on be...
I work at a company that, for some reason, insists that all our development documentation should be in MS Word format. Which, being a binary format, means we cannot: Diff versions of a document against each other (so peer reviewing them is a pain - because of the domain we work in, peer reviews for all changes are essential) Grep a fo...
Hi there, I use XFire to create a webservice wrapper around my application. XFire provides the webservice interface and WSDL at runtime (or creates them at compile time, don't know exactly). Many of our customers don't know webservices very well and additionally they simply don't read any external documentation like Javadoc. I know tha...
What are the best ways that you have found to document the use of an API? Comments on classes and methods, such as JavaDoc comments, are useful for learning about how a particular class or method works, but I'm asking about how people document higher-level concepts that show how to actually use the API. Comments that include code sampl...
Many database systems don't allow comments or descriptions of tables and fields, so how do you go about documenting the purpose of a table/field apart from the obvious of having good naming conventions? (Let's assume for now that "excellent" table and field names are not enough to document the full meaning of every table, field and rela...
My company does custom software for several companies. We have dozens of small software projects (and some larger ones), each with its own history, quirks and processes. We document this in an instance of MediaWiki), and that has worked wonderfully. Code documentation, on the other hand, is usually put with the code in source control....
For ActionScript 2, I've used NaturalDocs. However it has pretty poor support for PHP. I've looked so far at Doxygen and phpDocumentor, but their output is pretty ugly in my opinion. Does anyone have any experience with automatic documentation generation for PHP? I'd prefer to be able to use javadoc-style tags, they are short to write an...
Any suggestion how I can document my Perl code? What do you use and what tools are available to help me? Which module do you use to convert pod to html? ...
Are there any well-made web apps for writing tehcnical/API type manuals? I've got some code I want to write some "getting started" guides for and maybe some reference content. PHPDocumentor is all fine and good for documenting my class heirarchy, but I also want to put something together that is a bit more human readable and linear. I s...
I have an assembly containing very thorough XML-based documentation, which is used through Sandcastle to generate the help-files for the product. We also use the output XML files for providing proper Intellisense in Visual Studio when programmers use the assembly obviously. In order to do this, it seems we have do both supply the user w...
We are in the process of documenting a newly minted API for our applications. The API has been written in C++ as a set of COM objects. We would like a tool that generates CHM documentation based on the comments attributed to each COM object method. I know of doxygen but don't really feel like the output is all that professional lookin...
I have created an application which needs 'hand-over' to the support group in the next month. The application is fairly small (2 months development), and consists of two client side applications and a database, it's written in c# for the windows platform. I have a broad idea of what to include in a support document, but I haven't neede...
where will I find documentation for developing plug-in for Code::Blocks? Also, is there a comprehensive documentation for the Code::Blocks source code which I can use to modify the source and to add desirable functionalities to the Code::Blocks IDE ...
I need to start messing with a vb.net(vs2008) project file and I'd like a reference to, ideally, it's specification. Any links would be very helpful ...