На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- самое важное
- Технический писатель:
- @anindita_basu
- Название проекта:
- Просмотрите и уточните текст внутри продукта
- Длина проекта:
- Длительный ход (5 месяцев)
Описание Проекта
Я присоединился к каналу Slack и задал Эрику несколько вопросов. Основанный на
на его ответ (спасибо, Эрик!), я предлагаю подойти к этому проекту в
следующим образом:
Классифицируйте строки
Я начну с определения того, какие из строк ( https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json ) являются системными консольными, а какие предназначены для пользователя. Я предлагаю сначала взять на рассмотрение строки, ориентированные на пользователя.
Создайте руководство по стилю для строк
Я хотел бы определить стиль заглавных букв, длину и использование слов для строк, используемых в пунктах меню, кнопках действий, метках, заголовках, подсказках, ошибках, предупреждениях, проверках, уведомлениях и подтверждениях (см. пример снимка экрана руководства по стилю на https) . ://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG ). Кроме того, я хотел бы создать некоторые рекомендации по использованию токенов (заполнителей) в строках, особенно в составных строках.
Я стараюсь уместить это руководство на одну страницу листа формата А4, по возможности короче. Предполагается, что разработчики, которые на самом деле пишут эти строки, должны найти руководство быстрым и простым в использовании, плюс, если следовать ему, текст пользовательского интерфейса будет отображаться согласованно на всех экранах.
Я предлагаю сделать это по двум причинам: (а) чтобы обеспечить единообразие текста с точки зрения грамматики и стиля (б) чтобы даже после окончания GSoD существовал набор инструкций, к которым каждый мог бы быстро обратиться, когда они пишут текст пользовательского интерфейса
Просмотрите и доработайте текст
На основе руководства по стилю, созданного в № 2, я отредактирую строки и создам запросы на включение на GitHub.
=============
Продолжительность
Я пока не знаю, сколько строк являются строками, предназначенными для пользователя (именно это я и предлагаю рассмотреть в этом проекте). По моим оценкам, создание руководства по стилю займет около 3 недель (от черновика до утверждения), и эту работу можно выполнять одновременно с категоризацией строк как системных или пользовательских. Я предлагаю начать с предположения, что проект будет стандартной продолжительностью (3 месяца), где я беру на рассмотрение только такое количество строк, которое возможно в течение этого периода времени.
Поскольку я уже работаю полный рабочий день, я смогу работать над этим проектом только часть дня. Я открыт для возможности более продолжительного проекта, если вы считаете, что мое сокращенное рабочее время понадобится.