Tagged Questions
2
votes
1answer
106 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 ...
10
votes
7answers
328 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
408 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 ...
1
vote
2answers
326 views
Need tips for writing the software design specifications(SDS) and the software design document(SDD)
I have to write an project on a software system I'm building, and I have to write to documents called the software design specifications(SDS) and the software design (SDD). Could somebody please give ...
6
votes
5answers
929 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
233 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 ...
