Conceptual Design of New Documentation
As a service provider and contractor for technical documentation, I design concepts for clear, user-friendly user manuals, online documentation, and help embedded into the user interface of a product.
Have you developed a new product or new software? Do you need some user documentation, such as user manuals, online help (online documentation, help sites), or screencasts?
Based on a detailed user analysis, I can develop a user-friendly and cost-efficient user assistance and documentation solution for your product—from the underlying didactic concept down to the detailed structure.
As an option, I can also implement the designed solution, 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 be more expensive, and it will take longer. Why?
▪Many decisions need to be made during each project. You can make each decision either as part of a prior documentation plan, 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 need 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 very 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.