Работая в айтишечке
1.14K subscribers
287 photos
4 videos
56 links
Канал о том, как эффективно работать в IT: простые объяснения технических вещей, лайфхаки, лучшие практики и полезные инструменты для повседневных задач.

Автор: @Shevtsoff
Download Telegram
📝 The Good Docs Project

Сегодня расскажу о классном open-source проекте The Good Docs Project, который поможет создавать качественную документацию.

Это целая библиотека шаблонов и руководств по составлению документов для IT-проектов. Здесь есть всё: от описания процессов до детальных спецификаций.

Что внутри
— Готовые шаблоны документов
— Руководства по их заполнению
— Советы по написанию понятной документации
— Рекомендации по структурированию информации

🔗 Какие есть шаблоны
api-quickstart
— api-reference
— bug-report
changelog
code-of-conduct
— code-of-conduct-incident-record
code-of-conduct-remediation-record
— code-of-conduct-response-plan
— concept
contact-support
— contributing-guide
glossary
— how-to
— images
— installation-guide
— our-team
quickstart
— readme
— reference
— release-notes
— style-guide
— terminology-system
— troubleshooting
— tutorial
— user-personas

Перейти

💡 Подходит для
— Разработчиков
— Технических писателей
— Менеджеров проектов
— DevOps инженеров
— Всех, кто работает с IT-документацией

Спасибо создателям The Good Docs Project за то, что делают нашу работу удобнее!

Делитесь в комментах, помогает ли вам этот инструмент или знаете что-то похожее?

#documentation #tools #open_source
🔥52👏1