You are previewing Every Page is Page One.
O'Reilly logo
Every Page is Page One

Book Description

Every Page is Page One shows technical communicators how to document a large and complex product using only topics and enable readers to find and navigate topic-based content effectively.

Table of Contents

  1. Every Page is Page One
    1. Foreword
    2. Preface: In the Context of the Web
      1. 1. Audience
      2. 2. Discussion
      3. 3. Acknowledgments
    3. 1. Introduction
      1. 1.1. Every page is page one
      2. 1.2. Why do we still write books?
      3. 1.3. About the book
    4. I. Content in the Context of the Web
      1. 2. Include it all. Filter it afterward.
        1. 2.1. Just Google it
        2. 2.2. The long tail
        3. 2.3. Authority and experience
        4. 2.4. Aggregation and curation
        5. 2.5. Filter it afterward
      2. 3. The Distributed Nature of Content on the Web
        1. 3.1. How we use the Web
        2. 3.2. Dynamic semantic clustering
      3. 4. Information Architecture Top Down
        1. 4.1. Book navigation
        2. 4.2. The trouble with TOCs
        3. 4.3. Curriculum versus classification
        4. 4.4. The limits of hierarchies
        5. 4.5. The cultural bias toward hierarchies
        6. 4.6. The rise of the Frankenbooks
        7. 4.7. Faceted navigation
        8. 4.8. The limits of classification
        9. 4.9. Where top-down works
      4. 5. Information Architecture Bottom Up
        1. 5.1. A web of subject affinities
        2. 5.2. Irregular subject affinities
        3. 5.3. Subject affinities are not citations
        4. 5.4. Topics as hubs
        5. 5.5. The flattening problem
        6. 5.6. Broader, deeper, more dynamic
        7. 5.7. Should we abandon top-down navigation?
        8. 5.8. The role of lists
    5. II. Characteristics of Every Page is Page One Topics
      1. 6. What is a Topic?
        1. 6.1. Building-block topics
        2. 6.2. Presentational topics
        3. 6.3. Every Page is Page One topics
        4. 6.4. Economics and the evolution of topics
        5. 6.5. DITA and Information Mapping
        6. 6.6. Topics and the Web
        7. 6.7. Every page is still page one even if the reader reads several
        8. 6.8. Characteristics of EPPO topics
      2. 7. EPPO Topics are Self-contained
        1. 7.1. Self-contained, not all alone
        2. 7.2. The information scent of self-contained topics
      3. 8. EPPO Topics have a Specific and Limited Purpose
        1. 8.1. The scope of a topic
        2. 8.2. Task-based writing
        3. 8.3. Derived purpose
        4. 8.4. Defining the purpose of a topic
        5. 8.5. Topic purpose vs. user purpose
        6. 8.6. Purpose and topic size
        7. 8.7. Decision support and the reader’s purpose
        8. 8.8. Purpose and findability
      4. 9. EPPO Topics Conform to a Type
        1. 9.1. The evolution of topic types
        2. 9.2. Discovering and defining topic types
          1. 9.2.1. Discovering topic types
          2. 9.2.2. Defining topic types
          3. 9.2.3. Handling optional material
          4. 9.2.4. Serving the commercial purpose
        3. 9.3. Concept, task, and reference reconsidered
          1. 9.3.1. The origins of concept, task, and reference
          2. 9.3.2. A task is not a procedure
          3. 9.3.3. A reference is more than a topic
          4. 9.3.4. Everything else is not a concept
      5. 10. EPPO Topics Establish their Context
        1. 10.1. Establishing context
        2. 10.2. Context and the imprecision of search
      6. 11. EPPO Topics Assume the Reader is Qualified
        1. 11.1. Reader dependencies vs. subject dependencies
        2. 11.2. Determining the qualified reader
        3. 11.3. Choosing the level of understanding
        4. 11.4. Avoid arbitrary labels
        5. 11.5. Qualification and findability
      7. 12. EPPO Topics Stay on One Level
        1. 12.1. Books change levels at the author’s fiat
        2. 12.2. Keeping topics on one level
      8. 13. EPPO Topics Link Richly
        1. 13.1. Links and the democratization of knowledge
        2. 13.2. Linking and findability
    6. III. Writing Every Page is Page One Topics
      1. 14. Writing Every Page is Page One Topics
        1. 14.1. Textbooks vs. user assistance
        2. 14.2. Writing topics
          1. 14.2.1. Topics are self-contained
          2. 14.2.2. Topics have a specific and limited purpose
          3. 14.2.3. Topics conform to a type
          4. 14.2.4. Topics establish their context
          5. 14.2.5. Topics assume the reader is qualified
          6. 14.2.6. Topics stay on one level
          7. 14.2.7. Topics link richly
        3. 14.3. The question of style
        4. 14.4. Concerning reference information
        5. 14.5. Concerning tutorials
        6. 14.6. Concerning videos
          1. 14.6.1. Videos and linking
          2. 14.6.2. Videos as topics
          3. 14.6.3. Videos as objects
      2. 15. Every Page is Page One Topics and the Big Picture
        1. 15.1. Books and the big picture
        2. 15.2. The priority of the big picture
        3. 15.3. Writing the big-picture topic
        4. 15.4. Finding the end of the string
        5. 15.5. Pathfinder topics
      3. 16. Sequence of Tasks vs. Sequence of Topics
        1. 16.1. Working backwards
      4. 17. EPPO and Minimalism
        1. 17.1. EPPO as a platform for minimalism
        2. 17.2. Is EPPO minimalist?
        3. 17.3. Minimal vs. comprehensive
      5. 18. Structured Writing
        1. 18.1. The varieties of structured writing
          1. 18.1.1. Rhetorically structured writing
          2. 18.1.2. Computably structured writing
          3. 18.1.3. A word about SPFE
          4. 18.1.4. Other forms of computable structure
          5. 18.1.5. Open and closed formats
          6. 18.1.6. The varieties of computable structures
        2. 18.2. Benefits of computably structured writing
          1. 18.2.1. Improved content quality
          2. 18.2.2. Guidance for writers
          3. 18.2.3. Conformance and quality
          4. 18.2.4. Linking
          5. 18.2.5. Content manipulation
          6. 18.2.6. Future proofing
          7. 18.2.7. Single sourcing
          8. 18.2.8. Reuse
          9. 18.2.9. Content exchange
        3. 18.3. Structured writing and bottom-up organization
      6. 19. Metadata
        1. 19.1. The meaning of metadata
        2. 19.2. Topics should merit their metadata
        3. 19.3. Metadata comes first
      7. 20. Linking
        1. 20.1. Crowdsourced links
        2. 20.2. Soft linking based on subject affinities
          1. 20.2.1. Soft linking is not indirection
        3. 20.3. Soft linking and list generation
      8. 21. Reuse
        1. 21.1. Reuse on the Web
        2. 21.2. Static vs. dynamic reuse
        3. 21.3. Other forms of reuse
        4. 21.4. Reuse, linking, and interactive pages
      9. 22. Making the Case for Every Page is Page One
        1. 22.1. EPPO and resource constraints
        2. 22.2. EPPO and continuous delivery
        3. 22.3. EPPO and content change
        4. 22.4. EPPO and content aging
        5. 22.5. EPPO and agile methodologies
        6. 22.6. EPPO and content management
        7. 22.7. EPPO and PDF/help
        8. 22.8. EPPO and content marketing
        9. 22.9. EPPO and DITA
        10. 22.10. EPPO and wikis
        11. 22.11. Making the case for technical communication on the Web
          1. 22.11.1. Competitors will steal our ideas
          2. 22.11.2. Our users prefer PDF
          3. 22.11.3. No one reads the documentation anyway
      10. 23. Afterword: EPPO, but Not for Everything
    7. Glossary
    8. Bibliography
    9. Index
    10. Colophon
    11. A. Copyright and Legal Notices