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.
2
votes
5answers
241 views
What is the best way to understand code in a project with null documentation?
It is our first game and we are a start-up. We had a programmer who suddenly is seeming to be a dead weight. Though we knew him personally we thought that he was as motivated as we are and hence I ...
3
votes
5answers
395 views
What is the best way to prove that in-code documentation is greater than extensive external documentation?
What is the best way to prove to my boss that in code documentation is greater than extensive external documents containing documentation and screenshots of code/ui?
We have a group in the company ...
0
votes
0answers
56 views
What is expected in the documentation of a software project [duplicate]
I have about a month left to work on my final year project for college and between all my assignments and exams, I have to write documentation for it. On our college guidelines it states the ...
-1
votes
0answers
48 views
Documenting your research [closed]
Does anyone have any tips on documenting your research?
I am starting a project soon and I wanted to document my research for the project such as technologies to use, programming logic.
E.G.
...
2
votes
0answers
106 views
Diagrams used to model the architecture and functionality of a website
I am attempting to understand what UML models/diagrams can be used to communicate a websites architecture.
The model or models' purpose is to communicate the architecture and functionality of a ...
4
votes
1answer
93 views
Duplicating documentation on interface implementations/overrides good or bad?
So we have an interface like so
/// <summary>
/// Interface for classes capable of creating foos
/// </summary>
public interface ICreatesFoo
{
/// <summary>
/// Creates foos
...
-2
votes
0answers
69 views
NoSQL types drawbacks and advantages [closed]
what are the different advantages and disadvantages of each NoSQL type :(key-value,graph,document-oriented,column-oriented).
3
votes
4answers
373 views
NoSQL and BIG DATA
I am doing an internship on Big Data technologies so I am new to this area. My question is about the use of NoSQL in the Big Data architecture. Do we need always to use a distributed storage (like ...
5
votes
3answers
75 views
XML Documentation for IoC Classes
I'm working on an application that uses Inversion of Control to achieve loose coupling between the Data Access and Business Layers.
Having an ILoanApplicationRepository and a ...
35
votes
6answers
1k views
“I”, “We”, or Neither in code documentation
I find myself writing (hopefully) helpful comments in code (C++) documentation of the type:
The reason we are doing this is...
The reason I use "we" instead of "I" is because I do a lot of academic ...
3
votes
3answers
199 views
Is it correct to exclude argument names from function prototypes?
I was recently creating a small technical documentation for an application. The document is to be used by newly hired programmers to get acquainted with the application. It is much friendlier than the ...
3
votes
3answers
249 views
UML diagrams for small projects
All of a sudden the need for proper formal documentation has become a thing in our organization. A lot of work I do are enhancements and addition to an existing system. Generally a quick fix or a new ...
3
votes
1answer
82 views
Does doxygen support templates for the HTML output?
I've documented my code for doxygen, but I don't want the default HTML it gives. I know I can customize it by providing custom CSS, headers, footers, etc. (like GNOME does), and how I can add common ...
3
votes
2answers
84 views
What's a good format for documenting hundreds of data feeds?
Several governments are starting to publish open data: datasets generated by the goverment, made freely available for citizens to use for value-added app development, analysis, and feedback. For ...
2
votes
2answers
141 views
How do I document a communication protocol on top of message queues and channels?
I'm working on a large project at the moment and I'm trying to document the communication protocol that sits on top of a message queue middleware.
The documentation is intended for another ...
