На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Проект FreeBSD
- Технический писатель:
- Король тостеров
- Название проекта:
- Напишите недостающие страницы руководства. Добавьте разделы ПРИМЕР на страницы руководства.
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Напишите недостающие справочные страницы:
Список отсутствующих man-страниц можно найти на https://wiki.freebsd.org/MissingManpages . Начните писать как можно больше страниц руководства из этого списка. С помощью своего наставника найдите автора или кого-то, кто недавно изменил исходный файл, о котором идет речь на странице руководства, для получения дополнительной информации и подробностей.
Добавьте разделы ПРИМЕР на страницы руководства:
Страницы руководства FreeBSD во многих местах содержат разделы ПРИМЕР, описывающие базовое использование описанных в них утилит или команд. В вики FreeBSD есть список man-страниц без примеров ( https://wiki.freebsd.org/ManPagesWithoutExamples ). Добавьте в эти справочные страницы как можно больше примеров в тех случаях, когда их наличие имеет смысл. Придумайте общий способ представления команды/утилиты в этих разделах (т.е. сначала быстрый старт, затем более сложные примеры) и примените его к страницам руководства, описывающим подобные утилиты/команды. Таким образом, примеры имеют последовательный подход, и читателю будет проще разобраться.