|
As a service provider and contractor for technical documentation, we design concepts for clear, user friendly software user assistance, such as user manuals, online help files, demos and tutorials. When required, we also create and write the software documentation that we have designed.
Do you have developed a new product or new software? Do you need some user documentation such as user manuals or online help?
|
Based on a detailed target group analysis, we can develop a user-friendly and cost-efficient documentation solution for your product – from the underlying didactic concept up to the detailed structure.
However, be warned: As a result of the consequent focus on your target group, the designed solution will most likely not be the solution that you would prefer yourself if you were using your product. This is because you aren’t part of the target group and have special prior knowledge that your clients don’t have.
As an option, we can also author and produce the designed documents, or we can assist you in doing so.
|
Can’t professional writers just start writing and let the documentation “evolve”? Yes, they can, but it will always be the more expensive way and it will always take longer. Why?
| ▪ | Many decisions have to be made along the way of each project. You can make a decision as part of a prior concept, or you can make it “on the fly” when writing the text. Both takes the same time.
So, up to this point, there’s no gain by developing a prior documentation plan, but there’s no loss in time and money either. |
| ▪ | Many decisions are mutually dependent. Therefore, some of the decisions will always have to be revised as part of the process.
If you’re working on a plan, revising a decision is quick and costs nothing: All you have to do is change your mind. If you’re working on the actual document however, revising a decision is costly. You must change everything that you’ve produced so far. The more you’ve written, the more it costs. |
Now guess what’s safer, faster and more cost-effective. …
|
A sound documentation plan doesn’t have to be extensive, but it should at least answer the following questions:
| ▪ | Needs of the target group
What do your clients know already? How do they work? What are their main goals and tasks? |
| ▪ | Other imperative parameters
What fundamental restrictions must be taken into account such as deadlines, budget, frequency of updates, translation requirements. Does the documentation have to fit into a line of existing documents? In case of software: which operating system is used, which programming language is used, which browsers are available on the users’ computers? In case of software on mobile devices or operator panels on a machine: What’s the screen size? Is there a mouse and a full-featured keyboard available? |
| ▪ | Information types
What types of information do your clients need? Basic conceptual information, reference information, step-by-step instructions? Do you need to communicate general domain knowledge as well as specific application knowledge? |
| ▪ | Media
Should you provide a printed user manual (PDF), or context sensitive online help, or both? What information should go into the user manual and what information goes into the online help? |
| ▪ | Documents
What documents should you provide? Should you put all information into one document or should you supply several user manuals for specific purposes and user groups? |
| ▪ | Help formats / context sensitive help calls
Which help format should you use? Plain HTML or a special help format? Can context sensitive help calls be implemented? Who assigns the required help IDs: programmers or help authors? |
| ▪ | Navigation
Which navigational devices will you provide within your documents and online help systems? Where will you provide links / cross-references, and where not? |
| ▪ | Structure
How should your document(s) be structured? Which chapters / topics should you provide? |
| ▪ | Production
Which authoring tools should you use? Can these tools handle all the languages that you require today and in the future? |
As an option, a documentation plan may also comprise sample layouts and basic prototypes.
|
Contact us for a free quotation.
Keywords relating to this page: technical documentation - software documentation - user assistance - user documentation - information developer - information architect - user manual - user manuals - online help file - online help files - concept - design - plan - development - developing - information design - information concept - documentation concept - user assistance concept - user friendly - good - clear - well-written.
|
