Tuesday, March 25, 2008

Software documentation

There are two types of documentation which should be created for software. Those that are used internally within the company, and those that are used externally, by the customer.

Some examples:


Internal

Explanations of software.
  • What it is for
  • Who the intended users are
  • How it works
  • How it is developed
Sales tools


External

User guides

  • System requirements
  • Basic (user guide)
  • Advanced (user guide)
  • Installation
  • Upgrading
  • Troubleshooting
  • Moving an installation between machines

4 comments:

  1. Great post,Thanks for providing us this great knowledge,Keep it up.
    A good blog.
    Visit to friv than play games 2 girls and play game kids games online ! have fun!

    ReplyDelete
  2. This is a great web site. Good sparkling user interface and very informative blogs. I will be coming back in a bit, thanks for the great article. I have found it enormously useful..
    unblockedgames
    friv
    unblockedgames
    top tetris games
    | monster high

    ReplyDelete
  3. Big Farm

    Big Farm is an awesome multiplayer farm management game made by the Goodgame Studios.
    Your mission is simple: Create a big farm, grow crops, breed animals,
    and become the richest farmer of the universe. Enjoy Goodgame's Big Farm!

    ReplyDelete
  4. oakley sunglasses cheap, http://www.oakley.in.net/
    ray ban sunglasses sale, http://www.raybansunglass.us.com/
    true religion jeans, http://www.truereligionjeanscanada.com/
    snow boots outlet, http://www.wintercoats.us.com/
    coach outlet store, http://www.coachoutletstores.com.co/
    stuart weitzman sale, http://www.stuartweitzmanoutlet.us/
    giuseppe zanotti sale, http://www.giuseppe-zanotti-outlet.org/
    ugg outlet, http://www.uggoutletstore.eu.com/
    asics, http://www.asicsisrael.com/
    parajumpers sale, http://www.woolrichoutletstore.us.com/
    los angeles clippers, http://www.clippersjerseystore.com/
    tiffany jewelry, http://www.tiffany-outlet.us.com/
    calvin klein,calvin klein outlet online,calvin klein wholesale,calvin klein shoes,calvin klein underwear,calvin klein coats,calvin klein handbags
    cheap ugg boots, http://www.cheapuggboots.net.co/
    michael kors uk, http://www.michaelkorsoutlet.org.uk/
    ray ban sunglasses,ray ban sunglasses outlet,ray ban,rayban,ray bans,ray ban outlet,ray-ban,raybans,ray ban wayfarer,ray-ban sunglasses,raybans.com,rayban sunglasses,cheap ray ban
    arizona cardinals, http://www.arizonacardinalsjersey.us/
    manchester united jersey, http://www.manchesterunitedonline.com/
    kkk10 13

    ReplyDelete