Step 2
Design the information to support the user

  • Be consistent. Use:

    • The same types of information

    • In the same order

    • In the same style

  • Use an architectural style guide. Define:

    • The types of information to include

    • Where they go

    • What order

  • Write only the overviews the users really need

  • Layer the information for different users

  • Write procedures in task order

  • Set up topics to stand on their own

  • If there is more than one way to do it, explain only one way

  • Use structured writing:

    • Authors are guided to use the correct document architecture

    • Authors are freed from formatting tasks

    • Methods include:

      • SGML

      • XML

      • Structured FrameMaker





Fine distillation of information


Return to 7 Steps