Tagged Questions

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 ...
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 ...
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 ...
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
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 ...
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 ...
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 ...
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
173 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
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 ...
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 ...
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 ...