Книги для технического писателя#
Подборка интересных книг для технических писателей.
Note
Библиотека дополняется, прочитали что-то интересное – присылайте срочно!
Обязательно к прочтению#
“Руководства по стилю” (The Chicago Manual of Style) – Чикагский университет
Это авторитетное руководство по стилю, предназначенное для технических писателей и редакторов. Книга содержит правила и рекомендации по стилю письма, форматированию и пунктуации, которые помогут создать профессионально оформленную и последовательную документацию.
“Руководство по стилю от Google” (Google Developer Documentation Style Guide)
Это руководство по стилю от Google предоставляет рекомендации и указания для технических писателей, работающих над документацией продуктов и API компании Google. Оно включает советы по оформлению, стилю, терминологии и другим аспектам технической документации.
Полезное в практике#
Мильчин А. Э. Справочная книга издателя и автора
Настольная книга всех редакторов и технических писателей.
Розенталь Д. Э. Справочник по правописанию и литературной правке для работников печати
Справочник, предназначенный для издательских работников, в первую очередь редакторов, а также авторов, содержит основные сведения по нормативному правописанию и литературной правке. В справочнике имеются следующие три раздела: 1. Орфография. 2. Пунктуация. 3. Литературная правка.
“Техническое письмо и коммуникация” (Technical Writing and Communication) – Алан С. Прюитт, Филип А. Плиймон
Эта книга предоставляет техническим писателям практические инструменты и стратегии для создания четких и эффективных технических документов. Она поможет развить навыки структурирования и организации информации, а также научит коммуникации с аудиторией эффективным образом.
“Структурирование технических документов” (Developing Quality Technical Information) – Мишель Кэри
Книга поможет техническим писателям научиться создавать документацию, которая легко доступна и понятна для пользователей. Она включает методы структурирования информации и обучает, как организовать документы для достижения наилучшей читаемости и понимания.
“Техническое редактирование: Введение” (Technical Editing: An Introduction) – Ами Плангем
Эта книга предоставляет введение в техническое редактирование и поможет техническим писателям улучшить стиль и качество своих документов. Она обучает правилам редактирования и рецензирования текстов, чтобы сделать документы более точными и профессиональными.
“Техническая документация: Принципы и практика” (Managing Your Documentation Projects) – Джо А. Магио, Рева К. Нэппин
Книга предоставляет практические рекомендации по планированию, управлению и выполнению технической документации. Она поможет техническим писателям успешно вести проекты документирования, соблюдая сроки и качество.
“Техническое письмо для профессионалов: Сила слова” (Technical Writing for Professionals: The Power of Words) – Мери К. МакГоверн
Книга обучает, как использовать слова, фразы и структуры, чтобы создавать четкие и убедительные технические документы. Она поможет техническим писателям улучшить свои навыки по передаче сложной информации простым и понятным языком.
“Проектирование технических документов” (The Non-Designer’s Design Book) – Робин Вильямс
Книга предоставляет важные принципы дизайна и макета, которые помогут техническим писателям создавать профессионально оформленные документы. Она научит создавать привлекательные и понятные визуальные материалы.
“Техническое писательство: Принципы и практика” (Technical Writing: Principles and Practice) – Мейси Плэммер, Линда Тэтчер
Книга предлагает практические советы и инструменты для технического писателя, включая темы, такие как структурирование, стиль письма и процессы создания документации. Она поможет техническим писателям совершенствовать свои навыки и создавать качественные технические материалы.
“Руководства по стилю” (The Chicago Manual of Style) – Чикагский университет
Это авторитетное руководство по стилю, предназначенное для технических писателей и редакторов. Книга содержит правила и рекомендации по стилю письма, форматированию и пунктуации, которые помогут создать профессионально оформленную и последовательную документацию.
“Руководство по стилю от Google” (Google Developer Documentation Style Guide)
Это руководство по стилю от Google предоставляет рекомендации и указания для технических писателей, работающих над документацией продуктов и API компании Google. Оно включает советы по оформлению, стилю, терминологии и другим аспектам технической документации.
Документирование API#
“Документирование API” (The Art of API Documentation) – Джули Бакер, Дженнифер Роппелман
Книга фокусируется на документировании API и предоставляет инсайдерские советы и методы для создания полной, понятной и аккуратной документации для разработчиков. Она поможет техническим писателям научиться документировать различные типы API, включая RESTful и веб-API.
“RESTful API Design” – Мартин Фаулер
Книга фокусируется на дизайне RESTful API и предоставляет практические советы и лучшие практики для создания современных и эффективных API. Она поможет техническим писателям понять основы RESTful дизайна и создать документацию, которая легко сопровождается и используется разработчиками.
“Web API Design: Crafting Interfaces that Developers Love” – Браян Муллиган, Эшли Ричардсон
Книга охватывает важные аспекты дизайна веб-API и дает рекомендации по созданию простых, надежных и удобных API для разработчиков. Она поможет техническим писателям понять потребности и ожидания разработчиков, чтобы создавать удобные и интуитивно понятные документы.
Архитектура приложений#
“Архитектура с открытым исходным кодом” (Open Source Architecture) – Кэтлин Таррагона
Книга предоставляет понимание архитектуры с открытым исходным кодом и объясняет, как создавать модульные и масштабируемые приложения с использованием таких технологий, как микросервисы. Она поможет техническим писателям понять архитектурные концепции и документировать сложные приложения.
“Современная архитектура приложений на платформе Java” (Java Application Architecture: Modularity Patterns with Examples Using OSGi) – Кирк Купер
Книга предоставляет основы архитектуры приложений на платформе Java, включая примеры использования OSGi для создания модульных приложений. Она поможет техническим писателям лучше понять архитектурные концепции и документировать Java-приложения.
Описание баз данных#
“Базы данных: полное руководство” (Database Systems: The Complete Book) – Хектор Гарсиа-Молина, Джеффри Д. Ульман, Дженнифер Уидом
Это обширное руководство по базам данных поможет техническим писателям понять основы проектирования и управления базами данных, включая SQL, реляционные модели и современные базы данных. Они научатся документировать структуру и функциональность баз данных.
UML диаграммы#
“UML-диаграммы: Руководство пользователя” (UML Diagrams: A User Guide) – Гэри Ричардсон
Книга предоставляет понимание и руководство по созданию UML-диаграмм для моделирования систем и процессов. Она поможет техническим писателям научиться создавать четкие и информативные диаграммы для документации архитектуры и проектирования систем.
Описание интерфейсов#
“Дизайн интерфейса пользователя: Практическое руководство” (The Design of Everyday Things) – Дон Норман
Книга рассматривает принципы и лучшие практики дизайна интерфейсов пользователя, чтобы создавать интуитивные и удобные продукты. Она поможет техническим писателям научиться описывать интерфейсы с учетом пользовательских потребностей и легко читаемых инструкций.
Технические переводы#
“Технический перевод” (Technical Translation) – Дж. Ф. Роуч
Книга охватывает основы технического перевода и предоставляет рекомендации по переводу терминологии, технических текстов и документации. Она поможет техническим писателям развить навыки перевода и обеспечить точность и понимание в переводимых материалах.
“Редактирование технических текстов на английском языке” (Technical Editing) – К. В. Голышева
Книга предоставляет руководство по редактированию технических текстов, включая правила стилистики и грамматики на английском языке. Она поможет техническим писателям улучшить качество английской версии документации и обеспечить правильное использование терминологии.
Интересно почитать#
“Как пасти котов” (Herding Cats: A Primer for Programmers Who Lead Programmers) – Рейнвотер Дж. Ханк
Это книга о лидерстве и руководстве, о том, как первое совмещать со вторым. Это, если хотите, словарь трудных случаев управления IT-проектами. Программист подобен кошке, которая гуляет сама по себе. Так уж исторически сложилось. Именно поэтому так непросто быть руководителем команды программистов
“Deadline. Роман об управлении проектами” (A Novel About Project Management) – ДеМарко Том
На духоподъемном мероприятии, устроенном компанией для увольняемых сотрудников, мистер Томпкинс знакомится с очаровательной дамой. Та оказывается промышленным шпионом. Поболтав с ним немного, она… усыпляет его и перевозит в страну Моровию, где Томпкинс в итоге принимается за руководство мегапроектом по разработке нескольких программных продуктов: страна собирается стать лидером высокотехнологичного сектора.
Docs as code#
Docs Like Code: Collaborate and Automate to Improve Technical Documentation
Книга рассматривает методологию “Docs as Code” для укрепления команды технических писателей и повышения эффективности работы путем внедрения рабочих процессов, используемых разработчиками. Она подчеркивает важность сотрудничества, автоматизации тестирования, непрерывной интеграции, контроля версий, обзоров и развертывания, чтобы сделать процессы более согласованными и оптимизированными. Когда документацию воспринимают как код, команды получают возможность более эффективно взаимодействовать, а также более легко выявлять и исправлять проблемы с документацией в процессе ее разработки. Авторы также подчеркивают, что поначалу внедрение этой методологии может вызывать восторг, но с течением времени он может улетучиться, и важно научиться преодолевать сложности, учиться на своих ошибках и постоянно совершенствоваться. Третье издание книги включает новый подзаголовок и предоставляет информацию о том, как использовать подход “Docs as Code”, кто в этом процессе принимает участие, как проводить сбор требований и как планировать и внедрять систему “Docs as Code”. Предполагается, что читатель уже обладает знаниями в области технической документации. Когда документацию воспринимают как код, команды получают возможность более эффективно взаимодействовать, а также более легко выявлять и исправлять проблемы с документацией в процессе её разработки. Авторы также подчеркивают, что поначалу внедрение этой методологии может вызывать восторг, но с течением времени он может улетучиться, и важно научиться преодолевать сложности, учиться на своих ошибках и постоянно совершенствоваться. Третье издание книги включает новый подзаголовок и предоставляет информацию о том, как использовать подход “Docs as Code”, кто в этом процессе принимает участие, как проводить сбор требований и как планировать и внедрять систему “Docs as Code”. Предполагается, что читатель уже обладает знаниями в области технической документации.
Modern Technical Writing: An Introduction to Software Documentation
Небольшая книга, которая содержит базовые знания, необходимые для создания и публикации отличной документации по программному обеспечению. Книга «Modern Technical Writing», написанная ведущим техническим писателем одной из самых интересных компаний Силиконовой долины, представляет собой набор руководящих принципов и продуманных рекомендаций как для начинающих, так и для опытных технических писателей. Это не справочное руководство и не исчерпывающее, а скорее введение в разумный процесс написания и публикации документации, который слишком долго ускользал от профессии.
Pro Git
Полезная книга по работе с Git https://git-scm.com/book/ru/v2