Публикации по теме 'technical-documentation'


Документация по базе данных: Terra Incognita
Документация по базе данных: Terra Incognita Когда кто-то упоминает документацию по базе данных в ИТ-отделе, все мудро кивают, но стараются этого не делать. Компании редко заботятся о документации базы данных. Кажется, это одна из тех еще неизведанных территорий. Сейчас все знакомы с API или документацией по тестированию, но мало кто действительно понимает, что такое документация по базе данных и нужна ли она на самом деле. Проще говоря, документация базы данных так же важна, как..

Манифест без документов
«Недокументированный» код - новый идеал Необходима документация. Это важно. Это ценно. Тем не менее, несмотря на все предполагаемые преимущества, даже к концу 2018 года он остается в лучшем случае строчно-типизированным аварийным выходом на английский язык . Давайте проанализируем эту формулировку проблемы ниже, но не стесняйтесь пропустить этот раздел, если вы согласно кивнули. Проблема: документация - это строковый выход на английский (в лучшем случае). String-Typing :..

8 ценных уроков технического письма, которые я выучил в 2023 году (с точки зрения начинающих 🧐)
Техническое письмо 101 Введение Вы когда-нибудь сталкивались с проблемами при работе с электронным устройством и прибегали к чтению его руководства пользователя или инструкции? Если ответ да, то вы извлекли пользу из технического письма. Техническое письмо разбивает технический жаргон на простые для понимания шаги, которые может понять нетехнический человек. На прошлой неделе я посетил пространство в Твиттере, организованное Wisdom Nwokocha, профессиональным техническим писателем,..