Red Hat Documentation
Red Hat собрали в одном репозитории стандарты и соглашения, связанные с документацией своих продуктов.
Что там есть:
- Инструмент newdoc, который создает файлы в формате AsciiDoc по шаблону Red Hat.
- Гайд по модульной документации. Red Hat строит документацию основываясь на user-stories (пользовательских сценариях). В гайде есть раздел с шаблонами.
- Гайды нескольких продуктов Red Hat. Тут можно прочитать и про файловую структуру документации этих проектов, и про настройку окружения для работы с документацией.
- Общий стайлгайд.
#гайд
Red Hat собрали в одном репозитории стандарты и соглашения, связанные с документацией своих продуктов.
Что там есть:
- Инструмент newdoc, который создает файлы в формате AsciiDoc по шаблону Red Hat.
- Гайд по модульной документации. Red Hat строит документацию основываясь на user-stories (пользовательских сценариях). В гайде есть раздел с шаблонами.
- Гайды нескольких продуктов Red Hat. Тут можно прочитать и про файловую структуру документации этих проектов, и про настройку окружения для работы с документацией.
- Общий стайлгайд.
#гайд
GitHub
Red Hat Documentation
The location for fully open-sourced, freely accessible content on standards and conventions that relate to Red Hat's product documentation. - Red Hat Documentation