Google 文档季案例研究模板

<Org Name>:<Year> Google 文档季案例研究

组织或项目名称:

文档季链接:

组织说明:1-2 句话的宣传口号,简要概述贵组织或项目的业务。

作者:列出案例研究的作者;请根据要求使用用户名(可选)

摘要

请填写下表,并简要回答相应问题。您可以在后面的部分中提供更多详细信息。我们建议您先写出详细部分,然后再回过来写摘要。

# 技术文档工程师 TW 项目小时数 预算 项目完成百分比
## ## $X X%

您在尝试解决什么问题?您是如何尝试解决的?

您的项目取得了哪些成效?

哪些方面表现不错?您会采取哪些不同的做法?

对于其他尝试通过文档解决类似问题的项目,您有什么建议?

项目说明

填写以下部分,说明项目。

项目提案

提供提案的简要摘要,以及指向项目网站上提案页面的链接。

提案创建流程

您是如何构思 Google 文档季的提案的?贵组织是如何决定采用某个想法的?您如何征求和采纳反馈?哪些人参与了该流程?需要多长时间?

预算

回答下表中的问题。

您索要了多少钱?
您是如何得出此估算值的?
您为该项目预计了多少小时的工作量?
该项目实际需要几个小时的工作?
您的预算中还包含哪些其他费用?
在项目期间,您是否遇到过预算超支情况(例如错误估算)?如果是,请说明。

技术文档工程师招聘

您是如何寻找和聘请技术文档撰写者的?该流程是否顺利?他们是否在整个项目期间都留在了项目组?

其他参与者

还有谁参与了此项目(如果参与者要求,请使用用户名)? 您是如何招募他们的?他们担任着什么角色?他们是否留在了项目期间?

时间轴

简要介绍项目时间轴(指明预计结束日期或中间里程碑,如果项目仍在进行中)。原始时间表是否需要调整?

交付成果

填写以下表格,说明项目期间创建、更新或以其他方式更改的内容。包括计划内和计划外的交付成果。请务必包括计划但未完成的事项。

计划交付的成果

相关链接可能包括已发布的文档、拉取请求或其他工件。

提供的内容 已完成百分比 相关链接 备注
交付成果 1
交付成果 #N

非计划交付成果

是否创建了项目开始时未计划的任何交付项?如果是,请说明。

指标

您选择了哪些指标来衡量项目的成功?您能收集这些指标吗?您是否观察到该项目带来的任何变化?自提交方案以来,您是否添加或移除了任何指标?您今后打算多久收集一次指标?

分析

简要说明项目进展情况。项目是否成功?为什么?或者,您何时能够判断是否取得了成功?您是否遇到了任何意外的障碍或挫折?该项目是否促成了贵组织中任何新流程或更新流程或程序的产生?

经验教训

使用下表突出显示所学教训,包括取得的成效和有待改进的地方。根据需要使用所列的主题类别,或添加您自己的主题类别。您可以根据需要为给定主题添加多行。这些经验教训将纳入我们汇总的文档项目最佳实践列表中。

哪些方面表现不错?

主题 我们采取了哪些措施 经验教训
预算
通信
指导
指标
初始配置
参与者
项目交付项
项目管理
招聘
<Other Topics as Needed>
 
 

哪些方面有待改进?

主题 我们采取的措施 我们会采取哪些不同的做法 经验教训
预算
通信
指导
指标
初始配置
参与者
项目交付项
项目管理
招聘
<其他需要的主题>
 
 

附录

如果您有其他要链接的材料(例如,您创建了一份与技术文档撰写者合作的合同,想要分享该合同;或者您创建了文档项目的模板,或者其他公开的文档资源,您可以在此处列出并链接这些资源)。附录也非常适合列出您使用的任何文档工具或资源的链接,或者用于添加可能不适合前几部分内容的感谢或致谢。