|
Writing Style Guides and DTDs
|
|
Your need
Do your documents get written by different authors? Does quality vary? Do you need a clear set of rules and a common documentation standard to guarantee consistent output?
If you create XML or SGML structured documentation: Do you possibly even need a DTD (FrameMaker EDD) or a so-called specialization (adaptation) of DITA?
My service
Based on a close analysis of the requirements of your authoring system, of your authors, and of your clients, I can develop a clear set of information modules and rules which enable all authors to create user friendly documents of high and constant quality.
The information modules will be designed in a way which makes it possible to re-use single information components in other documents (single source publishing principle). The design of the structure allows the re-use of large components (such as whole topics or chapters) as well as the re-use of small components (such as individual paragraphs).
A lot of rule sets and DTDs turn out to be much too complex in everyday use. Working with too complex a structure, authors often lose more time with such rules and structures than they gain by being able to re-use certain modules of information. Therefore, my key criterion when designing a new DTD is a simple, clear and ergonomic structure. The fewer elements and rules the DTD requires, and the fewer levels the element hierarchy comprises, the better.
|
See also
Workshops / Coaching / Mentoring
|
|
|
|
|
 |
Software user assistance and documentation
since 1989
|
 |
Manuals and online help generated cost-effectively from one common text base
since 1995 |
 |
Numerous publications and presentations, e.g. on:
information design,
user guidance and navigation,
embedded user assistance,
single source publishing,
authoring tools
technical documentation process improvement
|
 |
| Winner of the Golden Disc from the German computer magazine CHIP |
 |
| Member of tekom, the German professional organization for Technical Communication and Information Development |
 |
Show intro:  |
 |
|