Questions tagged [documentation]
Software documentation is written text that accompanies computer software. It explains how the software operates, how to install it, how to use it, and other resources for help.
643 questions
2 votes
1 answer
204 views
Software Requirement Specification document "Purpose section"
When we write the "Purpose" section of a SRS document, do we write: The document purpose? or The Software to-be-built purpose? I have checked some examples and it seems the first one but ...
- 319
2 votes
2 answers
195 views
How should the changelog be updated if a change is backported from a newer branch to an older one?
Suppose I am developing an application with the following versions currently available: Latest stable: 1.3.0 Latest beta: 1.3.1 Latest alpha: 2.0.0 The project has a main branch for 2.x development ...
- 131
1 vote
1 answer
227 views
How to deal with outdated PowerShell and Azure PS in Azure Automation?
Azure Automation is a service for running scripts in the cloud, intended for the automation of administration tasks. While using it, I came across strangely outdated technologies being used under the ...
- 125
2 votes
2 answers
263 views
Correcting document errors in semantic versioning
Semantic versioning is a scheme of versioning that make the compatibility of different versions of a software component apparent to human and non-human agents. In essence, when a backwards-compatible ...
- 374
2 votes
2 answers
294 views
In Java Interface contracts, does the @throws tag order should be considered?
Concrete example : https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/DataInput.html#readFully(byte[],int,int) @throws NullPointerException if {@code b} is {@code null}. is before @...
- 131
10 votes
5 answers
4k views
Writing public libraries: Should I let the consumer of the library enforce thread safety?
I'm writing a .NET library which exposes certain public APIs. Currently, I have not enforced thread safety in my library for following reasons apparent to me: locks (Monitor.Enter and Monitor.Exit) ...
- 319
0 votes
1 answer
315 views
Creating necessary documentation for maintenance staff when only Code repository contents can be relied on
Conditions: stable legacy prod system no Software Devs of the system are available anymore app is maintained by Engineers, who do not have the same software dev experience like the original Devs and ...
- 125
2 votes
2 answers
197 views
How to document a concurrent communication protocol for less theoretical people
We are developing a multi-user web-based application, where the users can join a "room" and a complicated handshake has to be set up between them, to be able to use a library on each ...
- 61