Project Documentation

Timeline

One Pagers

  • Used to align with stakeholders.
  • One Page
  • Readers should understand the problem
  • Expected Outcomes
  • Proposed Solution
  • High level approach

Design Documents

  • Methodology
  • System Design
  • Experiment Results
  • Used for getting feedback

Review/Retrospective

  • Used to reflect after completion or major issue.
  • What went well, and what did not.
  • Follow up actions
  • What to do better

If its the review of a major issue,

  • Root cause(use 5 Whys)
  • How to prevent re-occurrence
  • Do NOT blame individuals

Eg. Amazon Correction of Errors

Links to this note

Write Better With Why What And How Framework

Use can use this in the Project Documentation. Why Explain the problem and context. Why is this document important Explain the problem Expected benefits of solving it. Why now This section is the "hook". People who read

Meta

Published on: Jun 14, 2022

Source: Link to Source

Tagged With: