创建案例研究

当前阶段：
2021 年“文档季”活动已于 2021 年 12 月 14 日结束。请参阅时间轴。

在 2021 年文档季活动中，组织需要提交最终评估和案例研究。您可以参考我们的案例研究模板和示例案例研究，为您自己的项目创建案例研究。

最终评估表单将在 2021 年 11 月 30 日世界协调时间 (UTC) 18:00 前至少一个月提供。

案例研究概览

案例研究模板将包含以下部分：

  • 问题陈述：您尝试通过新文档或改进后的文档解决了什么问题？
  • 提案摘要：原始组织提案的简要摘要
  • 项目说明：对项目的叙述性说明。包括：
    • 您是如何创建提案的（并链接到原始项目想法页面）。
    • 您招募和甄选技术文档工程师或其他参与者的方式。
    • 参与过项目的人员（如果参与者要求，请使用用户名）。
    • 项目完成所用时间（如果已完成）。
    • 哪些方面表现不错？
    • 哪些情况出乎意料？您遇到了什么障碍或挫折？
    • 创建、更新、改进或移除了哪些文档？
  • 此项目在您的组织中产生了任何新的或更新的流程或程序吗？
  • 指标：
    • 选择了哪些指标来衡量项目的成效？
    • 您能收集这些指标吗？
    • 这些数据是否与您预期的行为或基准相关？
    • 您选择的指标是否发生了变化？您是否移除或添加了任何指标？
    • 根据您的指标，您的项目是否取得了成功？（现在可能还为时过早。）
    • 您打算多久收集一次指标？
  • 摘要：
    • 在 2-4 个段落中，总结您的项目体验。您从中学到了什么？ 您日后会采取哪些不同的做法？对于尝试通过文档解决类似问题的项目，您会提供什么建议？

案例研究指南

  • 每周记录一次项目更新有助于您创建案例研究。 每周记录项目进度（包括拉取请求、问题或对话的链接，如果有用的话）、进展顺利（或不顺利）的情况、学到的东西以及提出的问题。
  • 撰写案例研究时，请保持友善。避免指责，并保持建设性。 请注意，案例研究是公开的！
  • 在案例研究中采用与博文或教程相同的语气；不要过于正式。