Technical Specification Tools?

Question

I am planning to write a technical specification document / functional specification for my personal project. Can anybody suggest any useful links / tools / templates that can help me?I am mainly looking for tools (preferably freeware).

Answer 1

IEEE and ACM both have many templates available for doing this, particularly for IT, of which I can speak.

If it is for IT, I can offer some suggestions for content areas of a technical spec:

Title, Author, and Date

Design description_______________________________________________

Business Reason________________________________________________

Technical environment____________________________________________

File Name(s) or Database Name(s)__________________________________

Timing and Conditions for execution of program________________________

Data Volumes___________________________________________________

Risks and Issues with possiible mitigations_____________________________

Inputs including screen definitions____________________________________

Processing Logic with pseudocode and diagrams________________________

Outputs_________________________________________________________

Controls_________________________________________________________

Error Processing__________________________________________________

Data Mapping____________________________________________________

Dependencies/Related Processes including diagrams_____________________

Initial Test Strategy and Overview Plans