如何写好一遍文档

明确目标

  • why: 这篇文档目的是什么,希望读者读这边文档达到什么样的效果。如:沟通一个决定/讲述一个状态
  • what: 确定我们文档需要解决的关键问题
  • who : 明确读者需求,站在读者角度了解他们的关注点在那里。给领导看、还是给特定的某些人群看,leader需要了解项目进展和项目质量、领导需要了解项目结果。

构思结构

读者不会直接赞成和否定你讲述的观点的正确与否,而是关注你对你所提出观点的论证。

  • SCQA结构来聚焦范围和问题


    image.png

    image.png
  • MECE 来架构清晰的主题
    主题不重复、不遗漏


    image.png
  • 结论性的语句要放在文档开头和段首
    塔尖的信息不是原因而是结论、不是过程而是结果、不是细节而是全局、不是问题而是措施。

撰写内容

image.png

检查细节

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。