TechRepublic|Forums|Web Development

Web Development

General discussion

  • Creator
    Topic
  • June 21, 2006 at 1:08 pm #2192046

    Documentation templates

    Locked

    by danlm · about 16 years, 11 months ago

    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

    Topic is locked This conversation is currently closed to new comments.
  • Creator
    Topic

All Comments

  • Author
    Replies
    • June 21, 2006 at 7:24 pm #3269120

      Reply To: Documentation templates

      by danlm · about 16 years, 11 months ago

      In reply to Documentation templates

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

    • June 29, 2006 at 2:08 am #3111682

      Reply To: Documentation templates

      by jaqui · about 16 years, 11 months ago

      In reply to Documentation templates

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

    • July 11, 2006 at 8:52 am #3211534

      Reply To: Documentation templates

      by streamlogic · about 16 years, 11 months ago

      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.
      http://www.streamlogicinc.com

    • July 11, 2006 at 5:41 pm #3209893

      Reply To: Documentation templates

      by danlm · about 16 years, 10 months ago

      In reply to Documentation templates

      This question was closed by the author

  • Author
    Replies
Viewing 3 reply threads