Technical Documentation Know-how

Do you create technical documentation yourself?
Here you can find basic know-how, working aids and links which help you to plan and create user friendly manuals, online help files and software demos.

Information Layering: Providing Need-based Information
Shows how you can separate content and make it accessible independently so that users only have to read what they really need to know in a specific situation. As a result, users will no longer consider documentation to be "useless anyhow" and customer satisfaction increases rapidly...
Creating User-friendly Links
Shows how you should design the texts of your hyperlinks so that they do not distract the reader and make it predictable which information will be given when a link is followed. This prevents a lot of frustration and makes every click a success...
Management Methods to Lower Documentation Costs
Makes suggestions on how you can apply proven business management methods to make the creation of technical documentation more efficient – without any costs for new technology at all...
Documentation Quality Checklist
Helps you to identify potential weaknesses of existing documentation and can be used to evaluate you own work or the work of others...
Checklist: Choosing a Help Authoring Tool
Provides hints what to bear in mind when looking for a suitable authoring tool to create technical documentation. This helps you to identify a solution that truly fits your individual requirements and now and in the future...
Checklist: Choosing a Screen Capture Tool
Shows what to take into consideration when looking for a specialized software to take and edit screen captures ("screen dumps, screenshots")...
Checklist: Choosing a Software Demo Tool
Lists criteria for the selection of a software to create interactive software demos (screencasts)...

Useful software

This section provides you with an up-to-date market survey on the key software required for creating manuals, online help and software demos. All the information is absolutely neutral and free of any interest in selling a specific tool.

Useful web sites

In addition to the articles and software reviews mentioned above, you can find a collection of recommendable web addresses relating to all questions involved in writing technical documentation.

Templates

Do you need professional, efficient templates for your documents?
Please take a look at the indoition Template Suite section.

Professional services

Do you need some competent assistance, or do you want to source out creation of your technical documentation completely to an experienced contractor?
Please refer to the Professional  Services section.

 

Copyright | Terms of Use | Linking to indoition | Imprint

Newsfeed

 
Welcome to indoition engineering Marc Achtelig,

User Assistance Solutions & Technical Documentation Services.
Here you can find
Know-how,
Tools,
Templates,
Professional Services

for the creation of
Manuals,
Online Help,
Software Demos.
A service of indoition engineering Marc Achtelig – documentation contractor, online help specialist, single source publishing expert.
Show intro: