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 个月），在此时间范围内，我只会尽可能少地提交字符串以供审核。

由于我已经全职工作，因此只能在白天部分时间处理此项目。如果您认为我缩减工作时间后需要更长时间的项目，我可以考虑。