The tasks and requirements of software documentation are many and varied.
A distinction has to be made between standard software or customer-specific adaptation / development, between life cycle phases of the software product (development phase, different test phases, establishment on the market, release change, update and upgrade phases, migration and discontinuation).
From the customer's perspective there are various roles which must be supplied with different information: Purchasing/marketing information, administration and installation documentation, training information, user manual, system manual, migration and update guide.
Software documentation is also helpful for know-how transfer: eLearning and Video tutorials considerably facilitate access to knowledge about software.
As we develop software und and implement software projects for many customers ourselves, we have the necessary experience and knowledge of which information is required where, and how it needs to be prepared. Context-sensitive online help, consistent terminology in product information, source text descriptions and user interfaces are just as important here as current availability in all required languages.
Software documentation (examples):
- User documentation
- Installation instructions
- Online help
- Administration manual
- Quick reference guide
- Quick start guide
- Marketing documentation
- Training material
- Update documentation
- Release notes
- Requirement specifications
- Technical specifications
- Source code documentation
Media and structures:
- Paper and PDF
- Context-sensitive online help
- Various help formats and WebHelp
- Video tutorial
- XML standards, such as DITA and DocBook
Fields of activity:
- Terminology management
- Multilingualism and translation management
- Re-use and modularisation
- Product and project documentation
- Internal and external documentation