Writing Style Guides and Structures

We design and create structures, writing style guides, DTDs and XLM schemas for user manuals, online help files and other forms of technical documentation, especially software documentation. Our primary goal always is to keep all rules as simple as possible and all structures as flat as possible.

Are your documents 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-structured documentation: Do you possibly even need a DTD (FrameMaker EDD / XML schema) or a specialization (adaptation) of DITA?

Based on an in-depth analysis of your clients’ requirements on the one hand, and on the requirements resulting from development and sales on the other hand, we can develop a clear set of information modules and rules (writing style guide). This set of rules is the common basis that  enables all authors to create user-friendly documents of high and consistent quality.

The information modules are designed in a way that makes it possible to reuse single information components in other documents (single source publishing principle). The design of the structure allows you to reuse large components, such as whole topics or chapters, as well as to reuse small components, such as individual paragraphs.

Many rule sets and structures turn out to be too complex and therefore can’t be used efficiently. When this happens, authors often lose more time than they gain by being able to reuse certain information modules. Therefore, our key criterion when designing a new DTD / schema is a simple, clear and ergonomic structure. The fewer elements and rules are needed, and the fewer levels the element hierarchy comprises, the better.

 

 

Contact us for a free quotation.

Keywords relating to this page: technical documentation - software documentation - software user assistance - user documentation - writing style guide - document structure - DTD - schema - XML schema - DITA - information design - creating - creation - development - developing.

 

Imprint | Copyright | Terms of Use | Linking to Us | Acknowledgements

Subscribe to newsfeed Newsfeed

Bookmark and Share
Software user assistance since 1989.
Various publications and presentations on technical writing, technical communication, and user assistance (UA).
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 (80 seconds):  Play