Контур
- Контур
- Ресурсы
- Что такое техническое письмо?
- Статьи
- Книги
- Курсы
- YouTube
- Сообщества
- Написание инструментов
- Инструменты документации
- Кто платит техническим писателям
- Проекты с открытым исходным кодом
- Проекты/программы с открытым исходным кодом. Технические авторы могут внести свой вклад в
- Блоги, за которыми следует следить за отличным содержимым письма
- Подготовка к техническому письменному интервью
- Сайты для публикации статей
- Доски для технического письма ролей
Ресурсы
Этот репозиторий содержит различные технические письменные ресурсы, которые были собраны со всего Интернета
Что такое техническое письмо?
Техническое письмо - это форма общения, которая помогает пользователям решать проблемы с технологиями. Это процесс создания четкого, краткого и информативного контента, предназначенного для передачи сложной информации таким образом, который легко понять предполагаемой аудитории.
Это часто включает в себя написание руководств, руководства, отчеты и документацию, которые объясняют технические концепции, процессы или продукты.
Статьи
- Техническое письмо за пределами постов блогов
- Как начать с технического письма
- Как стать техническим писателем
- Техническое письмо для начинающих - руководство AZ по основам технического блога
- Техническое письмо: что и как?
- Как изучать техническое письмо бесплатно
- Начало работы с техническим письмом
- Консультации по техническому письму
- Как писать контент, который читатели будут читать на основе изучения психологии пользователей
- Как создать портфель технического письма
- Советы по написанию разработчиков программного обеспечения - как стать лучшим техническим писателем
- 11 лучших практик для написания документации API
- Техническое письмо против технического ведения блога
Книги
Хорошо писать ~ Джулиан Шапиро
Техническое письмо, упрощенное ~ Нелл Джонсон
Написание для разработчиков SOTWARE ~ Филипп Кили
Техническое письмо для чайников ~ Шерил Линдселл-Робертс
Документы для разработчиков: полевое руководство инженера по техническому письму ~ Джаред Бхатти
Современное техническое письмо: введение в программную документацию ~ Эндрю Эттер
Все пишут: ваше руководство по созданию смехотворно хорошего контента ~ Энн Хэндли
На написании хорошо ~ Уильям Зинссер
Техническая коммуникация ~ Майк Маркель
Курсы
- Технические курсы для инженеров
- Техническое письмо: как написать программную документацию
- Изучите техническое письмо API: JSON и XML для писателей
- Искусство документации API
- Документирование API: руководство для технических писателей и инженеров
- Курс сертификации технического писателя ~ Курс сертификации технического писателя был создан для начинающих технических писателей или людей, которые хотят освежить свои навыки технического письма.
- SEO для Devs ~ SEO для Devs - это бесплатный 2 -недельный курс, который помогает людям раскрыть ваш технический блог или побочный проект систематически
- Документация API для разработчиков ~ Практическое руководство по созданию и поддержанию документации API.
YouTube
- Doctohelptv
- Технический писатель штаб
- Амрута Ранаде
- Уильям Смит
- Как стать техническим писателем | Навыки и карьерный рост
Сообщества
Сообщества могут предоставить ценные возможности обучения, рост, наставничество и карьерный рост. Общение с людьми, представляющими аналогичный интерес, является одной из причин, по которой люди присоединяются к общинам. Вот некоторые из сообществ, к которым могут присоединиться технические писатели:
- Напишите документы
- Докнекс
- Хакмамба
- Сообщество технического письма LinkedIn
- Глобальное сообщество писателей
- Группа документации API
- Форум технических писателей
- Hashnode
- Сообщество проектов хороших документов
- TechWriters.Dev
- R/Техническое написание
Написание инструментов
- Canva ~ Canva - это платформа графического дизайна, используемая для создания графики, презентаций, плакатов, документов, документов и другого визуального контента.
- Удалить инструменты, которые используются для удаления фона изображений.
- Markdown ~ Markdown-это инструмент преобразования текста в HTML для веб-авторов.
- Asciidoc ~ Asciidoc - это легкий и семантический язык разметки, в основном предназначенный для написания технической документации.
- Jenigma ~ Jenigma - это инструмент, который объясняет код на понятном английском языке.
- Grammarly ~ Grammarly - это ассистент для печати, который рассматривает орфографические, грамматику, пунктуацию, ясность, взаимодействие и ошибки доставки.
- Приложение Hemingway ~ Приложение Hemingway - это веб -приложение и настольное приложение, которое может улучшить ваш стиль письма и подкрасить ваш контент.
- Quillbot Ai ~ Quillbot AI-это многоцелевой инструмент для написания, который может помочь в улучшении вашего стиля письма. Некоторые из его продуктов-Parphraser, Grammar Checker, Plagiaris-Checker, соавтор, суммализатор, генератор цитирования и счетчик слов.
- Понятие ~ Понятие-это рабочее пространство в одном для ваших заметок, задач, вики и баз данных. Это инструмент, который вы можете использовать для организации своих мыслей, проектов и информации.
- Dropbox Paper ~ Dropbox Paper - это онлайн -рабочее пространство документа, где вы можете организовать и отображать текст, носитель и файлы в одном месте.
- GOFULLPAGE - Полный захват экрана ~ chrome Extension Taht позволяет сделать полный скриншот вашего текущего окна браузера.
- Углерод ~ Углерод - самый простой способ создания и обмена красивыми изображениями вашего исходного кода.
- ISITWP ~ ISITWP HEADLINE TOULUDE помогает вам писать заголовки, которые приводят к тому, что трафик, акции и лучше занимаются результатами результатов поиска.
- Зажигайте мое название ~ Упростить заглавную капитализацию для вашего письма
- Wordtune ~ Wordtune превращает текст в краткие, увлекательные, хорошо написанные сообщения.
- Оголочный анализатор ~ Записывает заголовки, которые приводят к трафику, акциям и результатам поиска.
- Генератор заголовков ~ Создайте отличные названия для статей и постов в блоге.
- SEO Phising Assistant ~ Редактор умного письма, который поможет вам оптимизировать вашу копию для участия и SEO.
- Hackmd ~ Редактор совместной маркировки для обмена своими статьями и получения отзывов от других.
- Copyscape ~ Проверка плагиата
- Markdoc ~ Superset of Markdown для создания пользовательских веб -сайтов документации. Он был создан Stripe и сделан с открытым исходным кодом в мае 2022 года.
- Wordtune ~ Wordtune- это компаньон с писанием с писанием, который перефразирует ваши предложения, чтобы сказать именно то, что вы имеете в виду, посредством четкого, убедительного и подлинного письма.
Инструменты документации
- GitBook ~ Современная платформа документации, где команды могут документировать все, от продуктов до внутренних баз знаний и API.
- Прочитайте платформу Docs ~ с открытым исходным кодом для хостинга, строительства и документации по управлению версиями.
- Docusaurus ~ Статический генератор сайтов, который позволяет легко создавать веб-сайты проекта с открытым исходным кодом.
- Sphinx ~ генератор документации, который преобразует файлы реструктурированного текста в веб -сайты HTML и другие форматы.
- MKDOCS ~ быстрый, простой и статический генератор сайтов, который предназначен для строительства документации проекта.
- Swagger ~ Набор инструментов для документации API, включая редактор Swagger, Swagger UI и Swagger Codegen.
- Postman ~ платформа для сотрудничества для разработки API, которая позволяет легко создавать, обмениваться, тестировать и документировать API.
- Slate ~ Статический генератор сайтов, специально разработанный для документации API.
- Redoc ~ Инструмент с открытым исходным кодом для создания документации API из определений OpenAPI (ранее Swagger).
- Docz ~ Инструмент для написания документации для ваших компонентов React с поддержкой MDX и Live-Reload.
- Jekyll ~ Статический генератор сайтов, который превращает простой текст в статические сайты и блоги.
- Hugo ~ быстрый и гибкий статический генератор сайтов, написанный в Go.
- Antora ~ генератор сайта документации для создания порталов документации и веб -сайтов технической документации.
- Vuepress ~ Статический генератор сайтов, работающий на vue.js.
- Asciidoctor ~ быстрый текстовый процессор и издательский инструмент для преобразования контента Asciidoc в HTML5, Docbook, PDF и другие форматы.
- Слияние ~ Инструмент сотрудничества, используемый для того, чтобы помочь командам сотрудничать и эффективно делиться знаниями.
- Madcap Flare ~ Комплексный инструмент технического авторизации и публикации для создания контента для различных выводов.
Кто платит техническим писателям
Написание технического содержимого для организаций и публикаций - отличный способ заработать дополнительный доход. Таким образом, вы многому учитесь, затем поделитесь своими знаниями и получаете оплату. Ознакомьтесь с этим составленным списком для организаций, которые платят технических писателей.
- Программа писателя сообщества
- Получите плату за написание за эти 45+ веб -сайтов
- Публикации, которые платят вам за написание технических статей
Проекты с открытым исходным кодом
Вклад в открытый исходный код может быть полезным способом обучения, обучения и создания опыта практически в любом навыке, который вы можете себе представить. Многие люди вносят свой вклад в открытый исходный код по разным причинам и жизненно важной, который улучшает набор навыков.
Вот несколько статей, которые помогут вам понять, как внести свой вклад в проекты с открытым исходным кодом.
- Открытый исходный код для технических писателей
- Руководство по техническим писателям по участию в проектах с открытым исходным кодом
- Как внести свой вклад в открытый источник как технический писатель
- 4 совета, чтобы стать техническим писателем с вкладом с открытым исходным кодом
- Начало работы с открытым исходным кодом в качестве технического писателя
Проекты/программы с открытым исходным кодом. Технические авторы могут внести свой вклад в
- Кодексадемия Docs ~ Docs-это коллекция кодовой документации для популярных языков программирования и фреймворков.
- Проект Good Docs ~ Проект Good Docs - это сообщество, работающее вместе для создания шаблонов, инструментов и ресурсов для улучшения общего качества документации в OSS и за ее пределами.
- Google Season of Docs ~ Season of Docs обеспечивает поддержку проектов с открытым исходным кодом для улучшения их документации и дает профессиональным техническим писателям возможность получить опыт работы в открытом исходном коде.
- Hacktoberfest ~ Hacktoberfest - это ежегодное мероприятие, побуждающее людей внести свой вклад в открытый исходный код в октябре.
- Проект документации GNOME
Блоги, за которыми следует следить за отличным содержимым письма
- Techwarters Hub
- Кеси Паркер
- Idratherbewriting
- Все техническое письмо
- WriteTech Hub
- Хакмамба
Подготовка к техническому письменному интервью
Есть несколько советов, которые могут помочь вам провести собеседование, но некоторые из важных из них имеют хорошо адаптированное резюме и сопроводительные письма. Ознакомьтесь с этими шаблонами сопроводительного письма и советов, которые помогут вам получить следующее интервью:
- Шаблон сопроводительного письма для вашей следующей работы
- Как написать заманчивое сопроводительное письмо
- Как написать резюме технического писателя [+примеры]
- Лучший пример сопроводительного письма технического писателя и формат
Вот несколько ресурсов для технического письма, которые помогут вам подготовиться к следующему интервью.
- 12 вопросов и ответов на собеседование технического писателя
- Google Технический писатель Вопросы интервью
- Техническое написание собеседования
Сайты для публикации статей
- Hashnode ~ Hashnode - это бесплатная платформа для ведения блога разработчиков, которая поможет вам поделиться своими идеями с людьми в технологиях, разработчиках и инженерами.
- Medium ~ Medium - это платформа социальной публикации с множеством пользователей, и вы можете публиковать разнообразное содержание и идеи.
- Dev.to ~ dev.to - это то, где программисты делятся идеями и помогают друг другу расти. Это онлайн -сообщество для обмена и открытия отличных идей.
- Mirror.xyz ~ mirror.xyz - это публикационная платформа для писателей, которая использует криптовалюту и технологию блокчейна.
- Freecodecamp ~ Freecodecamp-это некоммерческая организация, которая состоит из интерактивной веб-платформы обучения, интернет-форума сообщества, чат-комнат, онлайн-публикаций и местных организаций, которые намереваются сделать обучение веб-разработке доступным для всех.
Доски для технического письма ролей
Сделано с ❤ Дамилолой Иезекииль
