Download Single Sourcing. Building Modular Documentation by Kurt Ament PDF

By Kurt Ament

  • "The publication is a simple learn and is chock packed with suggestions and guidelines." -Ann Rockley

Content:
Foreword

, Pages ix-xi
Preface

, Pages xiii-xv
Chapter 1 - approximately unmarried sourcing

, Pages 1-22
Chapter 2 - development documents

, Pages 23-45
Chapter three - Structuring content

, Pages 47-147
Chapter four - Configuring language

, Pages 149-179
Chapter five - Leveraging technology

, Pages 181-201
Glossary

, Pages 203-208
Index

, Pages 209-230

Show description

Read Online or Download Single Sourcing. Building Modular Documentation PDF

Similar technical books

The DevOps 2.0 Toolkit

Automating the continual deployment pipeline with containerized microservices.

Multiple Stressor Effects in Relation to Declining Amphibian Populations (ASTM special technical publication, 1443)

Unique learn discusses the protocols and techniques to learning the results of a number of environmental stressors on amphibian populations and provides new views in this advanced topic. This new booklet integrates various stressors that could act in live performance and will eventually reason a decline in amphibian populations.

Intelligent Decision-making Support Systems: Foundations, Applications and Challenges (Decision Engineering)

This ebook could be obtained through researchers and graduates scholars in man made Intelligence and administration in addition to training managers and specialists attracted to the applying of IT and data platforms in actual company atmosphere.

Safety Aspects of Technical Standards / Sicherheitsaspekte technischer Standards: A European Comparison by the Example of Pressure Systems / Ein europäischer Vergleich am Beispiel druckführender Behältnisse

Das Buch behandelt das Thema "Sicherheitsziele und Schutzaspekte als Grundlage f}r Technische criteria in Europa - dargestellt am Beispiel druckf}hrender Umschlie~ungen". Es umfa~t die Ergebnisse einer internationalen Tagung der Gottlieb Daimler- und Karl Benz-Stiftung am 2. Mai 1990 in Ladenburg, an der Fachleute aus vier L{ndern der Europ{ischen Gemeinschaft und einem EFTA-Mitgliedsland teilgenommen haben.

Extra resources for Single Sourcing. Building Modular Documentation

Example text

TIP For related guidelines, see the following sections: ■ “Captions” on page 51 ■ “Figures” on page 74 Cross-references 57 Cross-referencing glossaries In the body of a document, cross-reference terms defined in the glossary. In the glossary itself, build “see” and “see also” references between terms. Cross-referencing glossary terms in text In online documents, build cross-references from technical terms used in content modules (for example, procedures and topics) to their definitions in your glossary.

Verifying module organization Make sure primary and secondary modules are organized properly: TIP ■ Primary modules Make sure each type of primary module is organized into a distinct section of your single-source document. For guidelines, see “Segregating primary modules” on page 31. ■ Secondary modules Make sure each secondary module is properly integrated into a primary module. For guidelines, see “Integrating secondary modules” on page 30. Module edits do not replace document edits. Once you assemble edited input modules into output documents, edit each output document.

Captions are titles to figures and tables. Include caption numbers in print. Do not include caption numbers online. Describe figures from the system perspective or the user perspective. Describe tables from the system perspective only. Cross-references . . . . . . . . . . . . . . . . . . . . . . . . Cross-references link the modules that make up a document. In printed documents, include page numbers in cross-references. In online documents, hyperlink cross-references.

Download PDF sample

Rated 4.21 of 5 – based on 4 votes