На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Фонд Linux
- Технический писатель:
- Сяоя
- Название проекта:
- Документация по сборке для проекта значков CHAOSS D&I
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Я изложил основное содержание следующим образом: основными целями являются расширение работы, связанной с документами, в рамках рабочего процесса, написание документации по бейджам D&I, ориентированной на сообщество, и размещение обработанной на нескольких языках документации на специализированной платформе, которую можно разделить на следующие микрозадачи: Обновить и интегрировать текущий шаблон PR с использованием большего количества показателей D&I и разнообразить вопросы. Подготовьте концептуальный обзор для представления программы выдачи значков D&I. Подготовьте руководство для заявителя, используя в качестве справочного материала документы JOSS. Составьте проект руководства для рецензента, используя в качестве справочного материала документы JOSS. Документ, объясняющий различные роли и соответствующие обязанности на протяжении всего рабочего процесса. Документ, объясняющий, как probot GitHub применяется в рабочем процессе. Руководство для участников, показывающее, как новичок может внести свой вклад в проект или документ. Помогу с переводом документов, проверю работоспособность автоматического перевода особенно на китайский язык, при необходимости выполню работы по ручному переводу. Организуйте документацию в многоязычном формате на основе переводческой работы. Используйте Gitbook, Read the Doc или GitHub Wiki для размещения документа.
Результат 1. Обогатите шаблон PR проекта и мероприятия дополнительными показателями и разнообразными вопросами. Этот результат включает в себя всю работу, связанную с документацией в рамках рабочего процесса, в частности шаблон PR, подготовленный для заполнения кандидатами. Я считаю, что это основной компонент рабочего процесса, поскольку он играет решающую роль в оценке рецензентов, поэтому форма и содержание Вопросы будут оттачиваться на протяжении всего рабочего процесса, и я буду доказывать это с учетом следующих моментов: На основе различных типов событий или проектов. В сочетании с большим количеством показателей D&I. Использование разнообразных способов постановки вопросов с требованием ответов, основанных на доказательствах.
Результат 2. Ниже приведен проект структуры документации для сообщества. Обзор значка D&I. Введение. Уровни значка цели. Подача заявки на получение значка. Подача заявки на получение значка мероприятия. Шаблон PR для мероприятия. Подача заявки на получение значка проекта.
Шаблон PR-проекта Рецензирование Как стать рецензентом Значок D&I Политика конфликта интересов Критерии проверки Контрольный список проверки Роли и обязанности Кандидаты - Создание рецензентов PR - Модераторы PR-ревью - Просмотр обзоров и заданий по проверке Сопровождающий - Окончательная проверка и объединение PR Кодекс поведения по бейджингу Probot D&I Как внести свой вклад
Результат 3. Организуйте документы в многоязычном формате и разместите их на таких платформах, как Read the docs или Gitbook.
В текущем рабочем процессе изучаются некоторые работы по автоматическому переводу, я помогу с проверкой того, насколько хорошо выполнен результат перевода, особенно на китайском языке, например, правильность и беглость перевода. Документ будет существовать в виде формата, я изучу платформы хостинга технической документации, такие как Read the docs, Gitbook и GitHub wiki, и выберу наиболее подходящую платформу для размещения открытой документации, доступной сообществу.