На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Инфраструктура компилятора LLVM
- Технический писатель:
- ДР87
- Название проекта:
- Реструктуризация указателя документации LLVM и руководства по стилю документации
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Данный проект включает в себя следующие задачи:
а.) Измените структуру индексной страницы документации, чтобы сделать ее более удобной для пользователя. Эта задача будет включать оценку текущей страницы и ее реструктуризацию на основе сочетания независимых исследований, интервью с МСП и отзывов пользователей. Возможные варианты включают пересмотр кратких описаний, реструктуризацию существующей страницы и/или добавление дополнительных слоев (страниц) с помощью модели постепенного раскрытия информации. Последнее уменьшит количество ссылок на главной индексной странице, чтобы пользователям было легче находить конкретную информацию/руководства. Например, индекс может включать ссылки на отдельные страницы, посвященные проектированию и обзору LLVM, руководствам пользователя, документации по подсистемам и документации по процессу разработки.
б.) Обновить руководство по стилю LLVM Sphinx для разработчиков открытого исходного кода. Эта задача будет включать оценку текущего руководства, выявление пробелов посредством независимых исследований и интервью с МСП, а также обновление руководства на основе согласованных требований. Обновления могут включать реорганизацию макета руководства, добавление нового контента и вставку ссылок на соответствующие страницы, такие как руководство для участников. Конечная цель — облегчить волонтерам возможность начать вносить свой вклад как можно скорее.