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