Conceptual Design of New Documentation
As a service provider and contractor for technical documentation, I design concepts for clear, user-friendly software user assistance, such as user manuals, online documentation, and help embedded into the user interface.
Have you developed a new product or new software? Do you need some user documentation, such as user manuals, online help (online documentation), or screencasts?
Based on a detailed user analysis, I can develop a user-friendly and cost-efficient documentation solution for your product—from the underlying didactic concept down to the detailed structure.
However, be forewarned: 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, I can also author and produce the designed documents, or I 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 during each project. You can make a decision either as part of a prior concept, or you can make the decision “on the fly” only when writing the text. Both takes the same time.
▪Many decisions are mutually dependent. Therefore, some of the decisions will always have to be revised as part of the process.
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 key questions:
▪Needs of the target group
▪Other imperative aspects
▪Help formats and context-sensitive help calls
As an option, a documentation plan may also comprise sample layouts and basic prototypes.
If you have any questions, please don’t hesitate to .