Рубрика «документация»

В технической и пользовательской документации часто встречаются фразы с использованием страдательного залога. Параметры там «задаются», файлы «сохраняются», а программа «запускается». Ох, опасная эта форма для строгих и однозначных описаний!

Почему же страдательный залог заставляет читателей страдать? Давайте разбираться.

Вопрос стоял об уплотнении

Вопрос стоял об уплотнении

Читать полностью »

Правила хорошего тона при оформлении технической документации

Правила хорошего тона при оформлении технической документации

Введение

В ИТ-компаниях не сразу пришли к тому, что нужен технический писатель, а про нормоконтроль вообще не задумываются, пока не придет пачка замечаний от заказчика. 

Читать полностью »

Swagger и полиморфные контракты в .NET 7 - 1


Не так давно состоялся релиз седьмой версии платформы .NET. Он привнёс множество изменений и интересных нововведений, по которым уже успели пробежаться в рамках новостного обзора.

В этой статье мы рассмотрим развитие сериализации платформы (System.Text.Json) вместе с возможностями, которые она открывает.Читать полностью »

У меня не было обложки, поэтому решил засунуть себя)
У меня не было обложки, поэтому решил засунуть себя)

Читать полностью »

Привет! Да-да, про тестирование ПО тут уже куча статей. Здесь я просто буду стараться структурировать как можно более полный охват данных из разных источников (чтобы по теории все основное было сразу в одном месте, и новичкам, например, было легче ориентироваться). При этом, чтобы статья не казалась слишком громоздкой, информация будет представлена без излишней детализации, как необходимая и достаточная для прохождения собеседования (согласно моему опыту), рассчитанное на стажеров/джунов.


ОСНОВНЫЕ ТЕРМИНЫ

Обеспечение качестваЧитать полностью »

Перешли всем отделом геймдизайна на Notion. Полёт нормальный - 1

Недавно наш отдел геймдизайна поменял основной инструмент и переехал с Google Документов на Notion — хотели решить проблемы хранения и организации документов. В общем, ни разу не пожалели. 

Читать полностью »

JSDoc - это язык разметки, используемый для аннотирования исходного кода JavaScript с использованием комментариев. Аннотации обрабатывается различными инструментами для создания документации в доступных форматах, таких как HTML и Rich Text Format.

Начало работы

Создание проекта

Для создания проекта выполните следующие команды:

  1. mkdir learn-jsdoc && cd learn-jsdoc - создание каталога проекта.

  2. npm init -y - инициализация проекта.

  3. touch index.js - создание файла index.js

Установка JSDoc

Выполните установку JSDoc одним из следующих способов:

  1. Глобально: sudo npm install -g jsdoc

  2. Читать полностью »


https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js