Ссылки
В справочнике собраны ссылки на полезные сетевые ресурсы: статьи, чаты, веб-сайты. Обращаем внимание, что администрация библиотеки не несет ответственность за данные интернет-ресурсы.
Мероприятия
- TechWriter Days ↗ – конференция технических писателей.
Инструменты
- WordExpert ↗ – рассказывает пользователям Microsoft Word о разных возможностях редактора, знание которых позволит увеличить производительность, эффективность и качество работы с текстом.
Онлайн-сервисы
- PDF24 ↗ – онлайн инструменты для работы с PDF.
- VK Cloud ↗ + Yandex Cloud ↗ – облачные хранилища с широким набором сервисов (например, файловый storage).
- Грамота ↗ – справочно-информационный портал «Грамота.ру» — ядро современной цифровой платформы русского языка, которая аккумулирует всю информацию о русском языке для широкого круга пользователей.
Примеры документации
- TeсhnicalDocs.ru ↗ – сайт по документированию информационных систем и программных продуктов.
- Матрёшка.ТВ ↗ – пример юридических документов для авторов и пользователей.
- База знаний Ozon ↗ – подробные инструкции о том, как продавать на маркетплейсе Озон.
- Twilio Docs ↗ – пример технической документации для разработчиков.
Профессия
- RoadMap for Technical writer ↗ – дорожная карта для технических писателей (англ.)
- TechWriters.ru ↗ – информационный сайт для технических писателей.
- Blog Engexp ↗ – блог технического писателя.
- Geek Writer ↗ – сайт технического писателя с 17-летним стажем.
- TechWriter Summary ↗ – сайт технического писателя с небольшой базой знаний.
- Techwritex ↗ – сайт технического писателя.
- Learn X in Y minutes – много кода.
Руководства по стилю
- Apple Style Guide ↗ – руководство содержит рекомендации по редактированию текста в учебных материалах Apple, технической документации, справочной информации, обучающих программах и пользовательских интерфейсах.
- Google developer documentation style guide ↗ – руководство содержит редакторские рекомендации по написанию четкой и последовательной документации для разработчиков.
- Microsoft Writing Style Guide ↗ – руководство по стилю написания и терминологии для любой коммуникации — будь то приложение, веб-сайт или технический документ.
Статьи
API
- Курс по документированию REST API ↗ – вольный перевод курса Documenting APIs: a guide for technical writers, составленного Томом Джонсоном, техническим писателем Amazon.
- Best Buy Developer API ↗ – пример документации API от Best Buy.
- Ci API ↗ – пример документации API от Ci Media Cloud.
- REST API Tutorial ↗ – руководство по REST API и JSON (англ.)
- Stripe API ↗ – пример документации REST API.
Telegram-чаты
- Про Obsidian на русском ↗ – канал про огранизацию и ведение базы знаний в Obsidian.
- Технические писатели ↗ – это самый многочисленный чат техписателей. Более 6000 участников.
- Техпис говорит | Подкасты ↗ – подкасты по теме разработки документации и прочим интересным темам.
- Техписалити ↗ – первая открытая школа технических писателей.
- HelpExcel.pro ↗ – канал про ИТ-оптимизацию бизнеса. Есть сайт.
- Parawriter ↗ – канал технического писателя о текстах, работе в айти и еще о чем-нибудь.
- TechWriter Days ↗ – чат с конференции технических писателей. Есть сайт.
- TechWriters.ru ↗ – группа для технических писателей. Есть сайт.
- quizzes4fun ↗ – канал с квизами для технических писателей.
ГОСТы
- RuGost.com ↗ – проект RuGost предназначен для помощи IT компаниям в работе с госзаказчиками. Сайт содержит ГОСТы и примеры документов.
Вёрстка интерфейсов
Прочее
- pnpm installation ↗ – установка pnpm через Homebrew (~10 мин).