Mattermost 项目

本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。

项目摘要

开源组织：

Mattermost

技术文档工程师：

@anindita_basu

项目名称：

查看并优化产品内文字

项目时长：

长期投放（5 个月）

Project description

我加入了 Slack 频道，并向 Eric 提问。
根据他的回复（谢谢 Eric！）我建议通过以下方式处理此项目
：

1. 对字符串进行分类

   首先，我会识别哪些字符串 (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) 是系统控制台字符串，哪些是面向用户的。我建议先使用面向用户的字符串以供审核。

2. 创建字符串样式指南

   我想为菜单项、操作按钮、标签、标题、提示、错误、警告、验证、通知和确认等字符串的大小写、长度和字词用法定义样式（请参阅 https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG 上的样式指南屏幕截图示例）。此外，我想围绕在字符串（尤其是复合字符串）中使用令牌（占位符）提供一些指导。

   我的目标是将本指南控制在 A4 大小的工作表的一页中，如果可能的话，篇幅简短。开发者的意图是，实际编写这些字符串的开发者应能找到快速且易于使用的指南，并且，如果遵循了这些指南，界面文本将在所有屏幕上保持一致。

   我建议这样做，原因有两个：(a) 让文本在语法和风格方面保持一致 (b) 即使在 GSoD 结束后，任何人都可以在编写界面文本时快速参考一组指令

3. 查看并优化文字

   我将根据第 2 部分创建的风格指南，在 GitHub 上修改字符串并创建拉取请求。

=============

时长

我还不知道有多少字符串是面向用户的字符串（这是我提议在此项目中进行审核的字符串）。我估计创建风格指南大约需要 3 周时间（从草稿到审批），并且可以同时完成将字符串分类为系统字符串或面向用户的工作。我建议先假设项目是一个标准时长（3 个月）的项目，在此时间范围内，我仅使用尽可能多的字符串来进行审核。

由于我已经拥有全职员工，因此只能在一天的部分时间处理这个项目。如果你认为我减少了工作时间，那么我愿意进行持续时间更长的项目。