Рубрика «документация» - 2
В поисках минимального ТЗ
2022-04-10 в 12:45, admin, рубрики: CRM, CRM-системы, документация, менеджмент, Подготовка технической документации, политика, управление проектами
Теория тестирования ПО просто и понятно
2021-11-06 в 16:45, admin, рубрики: виды тестирования, документация, теория тестирования, Терминология IT, тест-дизайн, Тестирование IT-систем, тестирование поПривет! Да-да, про тестирование ПО тут уже куча статей. Здесь я просто буду стараться структурировать как можно более полный охват данных из разных источников (чтобы по теории все основное было сразу в одном месте, и новичкам, например, было легче ориентироваться). При этом, чтобы статья не казалась слишком громоздкой, информация будет представлена без излишней детализации, как необходимая и достаточная для прохождения собеседования (согласно моему опыту), рассчитанное на стажеров/джунов.
ОСНОВНЫЕ ТЕРМИНЫ
Обеспечение качестваЧитать полностью »
Перешли всем отделом геймдизайна на Notion. Полёт нормальный
2021-10-11 в 16:00, admin, рубрики: Gamedev, google документы, notion, базы данных, Блог компании Lightmap, геймдев, документация, облачные сервисы, разработка игр, Управление продуктом, управление проектами, Управление проектом, хранение данных
Недавно наш отдел геймдизайна поменял основной инструмент и переехал с Google Документов на Notion — хотели решить проблемы хранения и организации документов. В общем, ни разу не пожалели.
Генерация документации с использованием JSDoc
2021-08-14 в 20:49, admin, рубрики: javascript, jsdoc, генерация документации, документация, Подготовка технической документации, Разработка веб-сайтовJSDoc - это язык разметки, используемый для аннотирования исходного кода JavaScript с использованием комментариев. Аннотации обрабатывается различными инструментами для создания документации в доступных форматах, таких как HTML и Rich Text Format.
Начало работы
Создание проекта
Для создания проекта выполните следующие команды:
-
mkdir learn-jsdoc && cd learn-jsdoc- создание каталога проекта. -
npm init -y- инициализация проекта. -
touch index.js- создание файлаindex.js
Установка JSDoc
Выполните установку JSDoc одним из следующих способов:
-
Глобально:
sudo npm install -g jsdoc
Прочти меня: код, который не выбесит соседа
2021-03-16 в 8:44, admin, рубрики: c++, codestyle, python, Блог компании Яндекс, документация, документация кода, идеальный код, Лайфхаки для гиков, Программирование, С++, Совершенный код, читаемость, читаемость кода, читаемый код
Сегодня поговорим о том, как писать код, чтобы он не злил окружающих и не раздражал вас спустя годы работы, когда вы снова попытаетесь его прочесть.
Я расскажу о подходах, которые мы используем в Яндекс.Такси для написания читаемого кода на C++, Python, JavaScript и других языках.
Читать полностью »
Об ужасной документации Apple
2020-11-13 в 6:30, admin, рубрики: apple, iOS, iPadOS, MacOS, swiftUI, tvos, Блог компании VDSina.ru, документация, Программирование, разработка под iOS, Разработка под MacOS
В последние год-два я пришёл к осознанию того, что основной преградой к выполнению моей работы является документация. Или, если конкретнее, откровенный дефицит документации, предоставляемой Apple для своих платформ.
Apple предоставляет разработчикам набор инструментов — API, позволяющий нам создавать приложения для iOS, iPadOS, macOS и tvOS. Во многих случаях разобраться в том, как пользоваться этими API, достаточно просто. Как отвёртку можно использовать очень немногими способами, так и во многих случаях есть только один очевидный способ применения API.
Читать полностью »
Внешний вид и скриншоты в пользовательской документации. Как надо и не надо делать
2020-10-26 в 7:12, admin, рубрики: Анализ и проектирование систем, Блог компании Блог компании «Актив», документация, технический писатель
Люди читают пользовательскую документацию, когда самостоятельно не могут с чем-то разобраться. Они не делают это для развлечения. И эмоции, которые преобладают в этот момент, далеко не всегда позитивные. Как разработчик пользовательской документации может помочь пользователю? Что ему необходимо учитывать при написании документа?
Как развивались комментарии к коду с 1940-х до 2020 года
2020-01-23 в 9:49, admin, рубрики: vscode, документация, инструменты разработчика, комментирование кода, ПрограммированиеА никак они не развивались. С самых первых языков программирования и по сей день комментарии коду — это всего лишь статичный текст (за некоторыми исключениями, о которых я расскажу).
Ну а что там еще можно улучшить или придумать — спросите вы. Давайте поразмышляем на эту тему — можно ли как-то улучшить наш опыт взаимодействия с таким важным но так часто игнорируемым аспектом программирования как документация в коде, или по-простому комментарии.
Читать полностью »
Docs as code против или вместе с Confluence? Обзор нескольких способов публикации из репозитория в Confluence
2020-01-15 в 13:59, admin, рубрики: atlassian, confluence, confluence api, docs as code, markdown, python, restructured text, rst, sphinx docs, wiki, документация, управление проектамиМногие уже давно или активно используют или смотрят в сторону модели хранения и публикации документации как кода, это значит применять к документации все те же правила, инструменты и процедуры, что и к программному коду, например, хранить в репозитории, прогонять тесты, собирать и релизить в CI/CD. Этот подход позволяет поддерживать документацию актуальной к коду, версионировать и отслеживать изменения, используя привычные инструменты разработки.
Однако в то же время во многих компаниях годами существуют также и вики-системы, в которых к документации получают доступ другие команды и сотрудники, например, менеджеры проектов. Что если вам захотелось привести хранение и публикацию к единому виду, то есть наряду с HTML публиковать доки и в Confluence? В этой статье я дам обзор решений задачи публикации документов из репозитория в Confluence.
Читать полностью »