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
3answers
139 views
How do you decide how much business requirements documentation you need and how to structure it? [on hold]
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
323 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
139 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
1answer
173 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
339 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
114 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
113 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 ...
3
votes
2answers
145 views
How do you validate need for documentation?
I once was on a project where a non-tech manager had the team spending half of every hour documenting what they just did so that someone with zero understanding of the tech would be able to understand ...
-1
votes
1answer
54 views
What are the most crucial categories of content to organize into an internal developer portal in a large company? [closed]
I have been tasked with organizing all of the company's internal content currently spread around sharepoint, a markdown reference manual and confluence into a single cohesive and usable portal in ...
37
votes
12answers
2k views
Documentation in OOP should avoid specifying whether or not a “getter” performs any computation?
My school's CS program avoids any mention of object oriented programming, so I've been doing some reading on my own to supplement it -- specifically, Object Oriented Software Construction by Bertrand ...
4
votes
3answers
148 views
Importance of diffing and merging for design specifications documentation
The context of this question is choosing tools for writing design specifications for software projects.
These documents will be written and maintained by architects and developers, I'm not talking ...
-3
votes
1answer
122 views
Version Control for One Man Dev Team? [duplicate]
I recently began work at a small company as a lone software developer. Before I came no true documentation/version control/etc. was in place. The best they have is Microsoft Word documents and Excel ...
13
votes
5answers
850 views
Is a well written documentation a good enough reason for learning a programming language?
I am learning Python currently which wasn't part of my college curriculum. I was asked in an interview why I chose Python and I replied that it is easy to learn and the documentation is very well ...
2
votes
2answers
264 views
What do you call parentheses operators?
In most programming languages documentation where they talk about operators +-*/=<> they also include ()[] as operators.
There are unary operators, multiplicative operators, additive operators, ...
1
vote
0answers
71 views
Are there any alternatives to ECLOX? [closed]
I am looking for a doxygen plugin for eclipse. Eclox seems to be the most popular plugin, but their homepage says
Since December the 1st of 2009, the development and the maintenance of eclox are ...
