Please enable JavaScript.
Coggle requires JavaScript to display documents.
DITA (BOOKS (DITA – the Topic-Based XML Standard: A Quick Start, Sissi…
DITA
BOOKS
DITA – the Topic-Based XML Standard: A Quick Start
, Sissi Closs, Springer, 2016
Developing Quality Technical Information: A Handbook for Writers and Editors
, Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde
DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA
, Laura Bellamy, Michelle Carey, Jenifer Schlotfeldt
IBM Style Guide, The: Conventions for Writers and Editors
, Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, Eric Radzinski
http://www.lulu.com/shop/sdi-global-solutions-and-julio-vazquez/practical-dita/ebook/product-17573865.html
http://www.lulu.com/shop/ann-rockley-and-steve-manning-and-charles-cooper/dita-101-second-edition/ebook/product-17383486.html
CONCEPT TOPICS
Use concept topics to:
introduce tools and technology
explain features, components, characteristics, restrictions, or capabilities
outline a process
define terms in more detail than you would in a glossary
describe a system, product, or solution
describe benefits or help users to make choices between options
don’t create concept topics unless you know your users need them
GUIDELINES
Create a concept topic only if the idea can’t be covered more concisely elsewhere.
Separate task information from conceptual information.
Describe one concept per topic.
Cover one main concept per topic - don’t let a concept topic go on for five pages by trying to cover too much.
XML ELEMENTS
<title>
Provides a topic or section title.
<shortdesc>
Introduces the concept: defining a broad term or idea, describing the benefits of the tool, solution, part, or component, outlining a process - but
keep short descriptions short
.
<conbody>
Contains more description of the concept where you can add sections, paragraphs, and other elements.
<section>
Contains a subsection that you can use to organize the conceptual information to to help users navigate and scan your content; add titles to sections by using the <title> element.
<ol>, <ul> ,<sl> , <dl>
Displays content as an ordered, unordered, simple lists, or
definition lists (<dlentry>, <dt>, <dd>).
<fig> and <image>
Provides a figure and caption so that you can insert graphics.
<term>
Highlights new terms; use the <term> element only for the first or most prominent occurrence of the term.
Click to download concept topic checklist.
Users read technical information because they want to accomplish a goal. The goal for users of most technical products is not to understand a concept but to complete a task, such as changing a tire, searching for files across multiple databases, or building medical devices.
When you write task-oriented technical content, you typically start by writing task topics that
focus on user goals. Then, you write concept topics to explain ideas that users need to under-
stand to complete the tasks. However, task and concept topics aren’t always enough: You of-
ten need to include reference information to further support those tasks.
Titles
CONCEPT TOPICS
noun-based
i.e. User roles
TASK TOPICS
verb-based
i.e. Create user roles
REFERENCE TOPICS
ff
ARTICLES
Author in DITA, publish with WordPress
DOCUMENTATION
odtworzyć w dicie menu, aby potem wklejac odwolania, a nie dokladne nazwy
If you want users to follow a procedure, write a task topic - not ordered list in concept topic.
converting non-
DITA content to DITA topics: