The documentation misbeliefs
- A well-designed and well-coded program won’t need any documentation.
- Software engineers are able to provide good documentation, as many companies try to accomplish.
Our beliefs
- Documentation is always needed even for the most user-friendly programs.
- Technical and end user documentation are inseparable part of any software product.
- Writing technical and user documentation is a different line of business, which requires different types of skills.
Our documentation challenge
The real challenge for us is to provide our clients with perfectly written, proof-read, well-structured and well-designed, searchable and indexed documentation that meets the specific needs and requirements of their product. Providing poor documentation can do even more harm than providing no documentation at all.
What can our professional technical writers offer to you?
Up2 has a professional documentation unit, which supports our project teams and our clients in delivering really high quality documentation.
Effective documentation project plan – there is a number of documents that can be written about a software product but which exactly are most appropriate for your products? They will help you decide whether you need:
- Online documentation
- Electronic offline documentation
- Printed documentation
- Video and audio materials
Technical documentation that is easy to read and understand by the users so they will search for their problem in the help before calling for support. This includes:
- Installation guides
- Training documentation – tutorials, CBT tools, video and audio
- Reference documentation
- System maintenance guides
- User Guides
- Evaluation guides
- Web-based helps
- Application-integrated helps
Marketing documentation that really tells about the features, advantages and benefits of your product in plain non-technical language and nice graphics to help users understand and like your products.
- Product sheets and brochures
- Product presentations
- Interactive demos
