• DocumentCode
    1393978
  • Title

    The design document: key to managing documentation development

  • Author

    Sole, Terrence D. ; Bist, Gary

  • Author_Institution
    IBM, North York, Ont., Canada
  • Volume
    34
  • Issue
    2
  • fYear
    1991
  • fDate
    6/1/1991 12:00:00 AM
  • Firstpage
    70
  • Lastpage
    74
  • Abstract
    It is pointed out that the design document is an effective way of managing documentation development, particularly in large-scale projects. It provides a rough picture or sketch of the information before the writing begins, thereby permitting changes in design before the course of the documentation is set. Once finished, it becomes a road map for writers, managers, and developers. It can later be used to verify that the design was implemented in the final text for publication. It is concluded that, although on first appearance it might seem that a design document simply adds one more thing to do on a project, the added effort is more than compensated for by the amount of time and money saved in not having to modify information at a much later point
  • Keywords
    desktop publishing; system documentation; user manuals; design document; project documentation development; user manuals; Built-in self-test; Contracts; Documentation; Helium; Large-scale systems; Manuals; Product design; Programming; Project management; Writing;
  • fLanguage
    English
  • Journal_Title
    Professional Communication, IEEE Transactions on
  • Publisher
    ieee
  • ISSN
    0361-1434
  • Type

    jour

  • DOI
    10.1109/47.87614
  • Filename
    87614