A documentation generator is a programming tool that generates documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of specially commented source code files, and in some cases, binary files. Document generation can be divided in several ...
5
votes
1answer
99 views
Standardized code documentation format, where is it?
I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.
Javadoc style is kind of an ubiquitous convention... it ...
5
votes
5answers
240 views
Where should a programmer explain the extended logic behind the code?
I have developed a few quantitative libraries in C# where it is important to understand not only the classic information that goes with the XMLDoc comments (which contains basic information with the ...
16
votes
5answers
439 views
How-to convince company to start documenting for legacy software
It has been less than a year since I joined my current company. Their majority of sales have come from a single product that has been alive since the last 10 years. However, there is minimal (if at ...
4
votes
6answers
317 views
Diagram that could explain a state machine's code?
We have a lot of concepts in making diagrams like UML and flowcharting or just making up whatever boxes-and-arrows combination works at the time, but I'm looking at doing a visual diagram on something ...
4
votes
3answers
103 views
What could be some pitfalls in introducing a style guide and documentation generating software in a development team?
I'm considering using appledoc, a flavor of Doxygen for use in generating Objective-C code documentation, in order to create documentation for my company's iOS apps. The idea is that a server will ...
5
votes
5answers
213 views
Whats sort of platform should I host documentation on?
We have a web-based software product that has a growing user-base of around 200+ people.
I won't go into details on our current workflow, but it involves word documents and converting to HTML and I ...
4
votes
2answers
107 views
What are the deliverables to give to the client for a web application ?
I have completed a web application which is basically developed in PHP and is just another regular web application. Usually when I deliver the final production release I just handover the code ...
2
votes
4answers
165 views
Code mapping in .NET (or in general)
Does there exist a software solution of some form that has the ability to map out the actions of calling a function.
So what I mean is, let's say that we have the following class.
public class Foo
...
3
votes
2answers
163 views
Using automated bdd-gui-tests to keep user-documentation-screenshots up do date?
Are there developpers out there, who (ab)use the CaptureScreenshot() function
of their automated gui-tests to also create uptodate-screenshots for the userdocumentation?
Background: Whithin the ...
1
vote
3answers
304 views
Documentation utility for OpenEdge ABL
I have a large system in OpenEdge ABL that could use some documentation-love. Currently a team member is working on a utility that can find methods and functions and make some "Javadoc-esque" html ...
5
votes
2answers
212 views
Requirement analysis software?
I've been looking for a software to help me put together requirements, activities to meet those requirements, time of completion, cost, etc, in a fairly easy fashion. Nothing too complicated it could ...
2
votes
2answers
89 views
How do I follow DRY when documenting module structure and interfaces?
In this paper, it is recommended that one document the following:
module structure
module interfaces
If I'm writing detailed module structures and interfaces in a standalone document, aren't I ...
2
votes
2answers
315 views
Best way to manage minutes of meeting
What is the best way of managing minutes of meeting on daily bases ? Do we have to manage the documents in a repository like VSS or it can be maintained in a excel sheet itself.
Kindly share your ...
3
votes
6answers
254 views
A big flat text file or a HTML site for language documentation?
A project of mine is a small embeddable Tcl-like scripting language, LIL. While i'm mostly making it for my own use, i think it is interesting enough for others to use, so i want it to have a nice ...
3
votes
1answer
174 views
How can the process of creating and maintaining documentation be improved?
I know it's a very subjective question , but this is one section of Software Engineering wherein I haven't seen any improvement in terms of how we can do it in a better way. I guess every programmer ...
2
votes
2answers
319 views
Best practices for documenting ASP.NET code
Any preferences for Asp.Net programmers on how to document their code?
I read XML with Sandcastle is a good way to go. What do you use?
11
votes
6answers
495 views
What tools are available to generate end user documentation?
End user documentation on how to use applications is an important part of the user experience of applications, irrespective of whether they are winforms, wpf or even asp applications.
In a startup ...
0
votes
2answers
395 views
PDF or ebook Java API documentation
Since I have a long train ride to and from work I was wondering if there is a version of the Java API documentation floating around that I could put on my Kindle. It would be nice on the rare occasion ...
2
votes
5answers
251 views
Generate HTML pages from some template
I have an open-source project for which I have to generate HTML pages to put on the web. I wanted to keep everything as simple HTML pages. The problem with this approach is if I need to change the ...
1
vote
1answer
181 views
printable PHP manual - 'all but the Function Reference section'
My Motivation
I find it easier to learn things by reading 'offline'.
I'd like to lean back and read the narrative part of a paper version of the official php manual.
My Scuppered Plan
My plan was ...
11
votes
2answers
509 views
What are the preferred documentation tools for the major programming languages?
I'm interested in compiling a list of major programming languages and their preferred documentation toolsets. To scope this a bit:
The exact structure of the answer may vary from language to ...
