На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Тритон
- Технический писатель:
- Дэйв
- Название проекта:
- Документация для базовых модулей
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
В этом проекте я предлагаю пересмотреть и обновить документацию по базовым модулям Tryton. Это модули, которые чаще всего необходимо активировать при настройке системы Tryton.
Улучшения в документации модулей Tryton помогут пользователям найти модули, соответствующие их потребностям, а затем помогут им настроить и использовать свою систему. Хорошая документация модуля позволит пользователям найти ответы на некоторые основные вопросы, не дожидаясь ответов на дискуссионном форуме.
Базовые модули включают как минимум следующие модули: account, account_invoice, account_invoice_stock, account_product, компания, страна, валюта, партия, продукт, покупка, продажа и складские модули.
Существует три основные аудитории документации Tryton: пользователи, системные администраторы и разработчики. Чтобы облегчить документацию по каждому из них, я предлагаю разделить документацию каждого модуля на отдельные файлы внутри каталога doc. Они могут включать файлы, содержащие оглавление и описание модуля, инструкции по настройке модуля, информацию о том, как использовать модуль, а также сведения о дизайне и структуре модуля. В зависимости от функциональности модуля некоторые из этих файлов могут не потребоваться, при необходимости можно создать дополнительные файлы. Улучшения модуля будут аналогичны тем, которые я уже предложил для модуля party: https://codereview.tryton.org/297241003/#ps327231002.
Подобная структура документации будет работать хорошо, поскольку в настоящее время документация генерируется Sphinx с использованием файлов reStructuredText. Когда я вношу изменения в документацию, они будут загружены на сайт проверки кода Tryton, чтобы их можно было просмотреть и обновить по мере необходимости. Как только все будут ими довольны, мы надеемся, что их можно будет одобрить для включения в Tryton.