Software documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles.
1
vote
1answer
70 views
Is there a tool to generate multi-goal procedural instructions? [closed]
As a user: When I have good instructions to follow I'm sure I could do just about anything. With poor instructions I end up frustrated, wasting time and probably giving up.
The type of instruction I ...
2
votes
3answers
236 views
How to explain to non-programmer to build my Visual Studio source code in “Release” mode?
I'm writing documentation for some software that I wrote. Specifically, I'm writing a guide to installing the software. I'm delivering the source-code to my client, so I expect that they will want ...
0
votes
1answer
37 views
How do I include Implementation and Usage Documentation in one file
There are two types of documentation.
One type, the Implementation Documentation, contains information about specific implementation of a construct (eg. Class, Method, etc.). It is targeted to the ...
18
votes
7answers
2k views
Old programmer disappeared. About to hire another programmer. How do I approach this? [on hold]
After spending over one year working on a social network project for me using WordPress and BuddyPress, my programmer has disappeared, even though he got paid every single week, for the whole period. ...
-2
votes
1answer
87 views
PDF to doxygen - how to do it? [closed]
I have a big pdf with the documentation for a project and I need to render this to doxygen (so take each function from the pdf and write it out into doxygen).
Any suggestions on how to do this ...
7
votes
1answer
210 views
Creating an effective C++ library website and documentation
Creating a C++ library also means documenting it so that others can use it, and that documentation can vary dramatically in quality.
How should a website for a C++ library be structured so that it ...
3
votes
1answer
77 views
Marking specific pieces of drastically changed open source code
I have taken a small chunk of open-source code, around a hundred lines, and found that for whatever reason, I have modified it so drastically that my end result has essentially no resemblance to the ...
-1
votes
1answer
67 views
Is there any standard for design document [closed]
This question is purely from academic point of view. As part of the software engineering lab, a design document is to be created after generating the SRS. Is there any standard for creating the design ...
1
vote
3answers
153 views
How do you decide how much business requirements documentation you need and how to structure it? [closed]
In the past couple of years, I've worked on two projects.
The first one, we used a very agile methodology. It was very much developer driven. As such, changes were very quick and rapid. Code quality ...
5
votes
5answers
371 views
Maintaining good form while learning new technologies
I find that I have to learn new technologies fairly regularly as a contractor in order to keep competitive.
However, I also find that (not only, but especially) in these circumstances, I tend to end ...
5
votes
5answers
181 views
Hyperlinked, externalized source code documentation
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document?
Given the expansive ...
-1
votes
2answers
209 views
How to write comments to explain the “why” behind the callback function when the function and parameter names are insufficient for that?
How should I approach writing comments for callback functions? I want to explain the "why" behind the function when the function and parameter names are insufficient to explain what's going on.
I ...
5
votes
4answers
350 views
Should user documentation include screenshots? [duplicate]
This question focuses on user documentation, not on code documentation.
I just finished my software project, and the people I work for are expecting me to write user documentation, describing ...
2
votes
2answers
145 views
Design document for project in C
I have had some experience in documenting the design for project developed in OOP languages. I made classes and used class diagrams to showcase the overall design structure of the implementation when ...
2
votes
1answer
156 views
How to find classes that use certain DB tables
Problem:
I'm asked to prepare a document where all our DB tables are listed and I'm supposed to list all Controllers that uses these DB tables for read and another list for Controllers that do write ...
