General discussion

Locked

Documentation templates

By DanLM ·
I am currently working for an establishment where the documentation on new inhouse projects/modules are more or less non existant. When I developed a unix script for them, and provided some module documentation that I had created they were extremly happy about it. In that I can provide some input at the ground level for documentation for them, I would appriceate some direction as to where I might be able to find some industry standard documentation templates.
The environments are: C, perl, Unix Scripts, Oracle, Web development, Java..
I'm looking for some good industry standard examples for: Project and module documentation. Unit and system test plans examples would be nice too.
They were very happy with what I put together for my module, but for all their environments. It would be nice to have a standard template that could be used for everything.

Dan

This conversation is currently closed to new comments.

6 total posts (Page 1 of 1)  
| Thread display: Collapse - | Expand +

All Comments

Collapse -

by DanLM In reply to Documentation templates

They also do vb, sorry. Missed that when I was entering this question at work.

Collapse -

by Jaqui In reply to Documentation templates

dockbook.
or write an xml scema for the documentation look they want.

Collapse -

by DanLM In reply to

Poster rated this answer.

Collapse -

by StreamLogic In reply to Documentation templates

Dan - I have used a few different tools, as well as developed my own documentation templates.

Tools: MZTools, tlb2html, HTML Help Workshop

These tools are very useful for automating the documentation process. If you would like templates that I have created for User Manuals, module structure, etc. pls email me. and I would be more than happy to share these.

Curtis
StreamLogic Inc.
www.streamlogicinc.com

Collapse -

by DanLM In reply to

Poster rated this answer.

Collapse -

by DanLM In reply to Documentation templates

This question was closed by the author

Back to Web Development Forum
6 total posts (Page 1 of 1)  

Related Discussions

Related Forums