views:

29

answers:

1

I am writing an app which is not simple (good to be ambitious etc...), but need to write documentation like requirements, design stuff, etc.

What would be a good tool which provides templates for all of this?

Thanks

A: 

Consider not using templates.

Often when you see design documents that were written based on some standardized engineering template, they tend to be 80% boilerplate / filler from the template, and 20% actual useful content.

Instead, find a design document that you like and use that as a stylistic model, but focus the content on what you think is going to be important to understand about your system.

An absensce of obvious boilerplate is the sign of a great design document in my book.

The sparer and cleaner the style the better - a good example in my book is something like the C# language specification document, which you probably have on your computer if you use Visual Studio for .NET development. It's rather austere and is admirably devoid of filler.

mtreit