Писать код легко, а вот документацию — тяжело. Часто смотришь на пустой
README.md и не понимаешь, с чего начать. Или вроде написал, но получилось мутно, и читать это никто не хочет.На GitHub случайно наткнулся на подборку Awesome Technical Writing — это аккуратно собранный набор ресурсов по техническому письму.
Там есть гайдлайны от Google, Microsoft и других крупных компаний, которые помогают держать терминологию и форматирование в одном стиле. Плюс собран полный рабочий цикл: планирование контента, инфоструктура, подготовка и публикация документации.
В подборку также входят программы для вклада в документацию опенсорса вроде Google Season of Docs, а ещё список вспомогательных инструментов: статические генераторы сайтов, линтеры для текста и прочий софт.
Если хочешь подтянуть документацию в своих проектах или смотришь в сторону технического писательства как отдельной профессии, эта коллекция точно стоит того, чтобы сохранить.
⭐️ Stars: 2k
➡️ Cсылка на GitHub
📱 @git_developer