Tagged Questions
3
votes
3answers
262 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 ...
2
votes
1answer
211 views
Why is it said that V-model introduces QA?
In several articles and books I learnt that "V-model introduced QA into SW development".
I would like to understand the point of such statement, as from my understanding, V model activities ...
1
vote
4answers
245 views
Is extensive documentation a code smell? [closed]
Every library, open-source project, and SDK/API I've ever come across has come packaged with a (usually large) documentation file, and this seems contradictory to the wide-spread belief that good code ...
2
votes
2answers
260 views
What norms/standards should I follow when writing a functional spec?
I would like to know what documents (ISO?) should I follow when I write a functional specification. Or what should designers follow when creating the system design? I was told that there was a ...
1
vote
2answers
111 views
How to correctly write an installation or setup document
I just joined a small start-up as a software engineer after graduation. The start-up is 4 year old, and I am working with the CEO and the COO, even if there are some people abroad. Basically they both ...
3
votes
3answers
378 views
Extreme Programming - documenting implementation?
In extreme programming methodology, what artifacts/ can be used to document the implementation?
I have used an activity diagram to document the design steps for each activity. I have read that for ...
6
votes
5answers
550 views
Open source software with good code documentation to improve design skill [closed]
As I'm trying to get better at designing good software I'm wondering if there are out there good (as in well written) open source software with lot of code documentation that aims to explain details ...
2
votes
1answer
158 views
Would you choose a database or a dvcs as storage for a documentation wiki?
I'm about to start coding a documentation oriented wiki, as a pet project. The core features are:
Extremely easy grouping of documents per version
Markdown syntax (subset of)
Multiple authors ...
12
votes
7answers
581 views
Should a design document contain a discussion of the pros/cons to a given design or should it focus on facts and rationale?
I'm currently in the process of updating a design document so that it is correct and up-to-date for future developers.
Currently, the document focuses on only the facts, presenting how the design is. ...
7
votes
5answers
735 views
Good references for End User documentation examples and advise
Our in house software has been used for many users and the training department asked us for any tips of end user documentation format.
Does any know where can I find good examples of software end ...
10
votes
5answers
5k views
Fastest way to document software architecture and design
We are a small team of 5 developers and I'm looking for some great advices about how to document the software architecture and design. I'm going for the sweet spot, where the time invested pays off. I ...
5
votes
3answers
365 views
How much time do you devote to the design document(s) for your software?
Obviously the size of the project you're working on will be a huge factor in how long you spend writing the design document/specification. But do you go through everything, picking out every tiny ...
