Руководство для раз

Составляем документацию разработчика пошагово без диет и тренировок

Недостаточно просто написать инструкции — важно, как, в каком порядке и где вы их разместите. 

Привет! Это Теодора — технический писатель Платформы, жизненно важного департамента Ozon. Документация для нас имеет большое значение, потому что вся компания пользуется нашими разработками: 

• инфраструктурой as a service;

• фреймворками и библиотеками на Go, C#, TypeScript;

• трейсингом, мониторингом, логированием, нагрузочным тестированием;

• инструментами для работы с базами данных и аналитикой;

• виртуализацией и контейнеризацией.

Опираясь на свой опыт, я пошагово расскажу, как привести в порядок документацию технической команды, чтобы избавить коллег от однотипных вопросов и наладить межкомандную коммуникацию.

Дисклеймер: в этой статье упор сделан на содержание, структуру и формат. Сугубо гуманитарные вещи вроде орфографии и пунктуации обсуждать не будем — они на вашей совести.

Зачем вам документация

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

Плюсы хорошей документации:

• увеличивается bus-фактор: знание распространяется между большим числом людей, и его сложнее потерять;

• команда не отвлекается на ответы на одни и те же вопросы и занимается своей работой;

• коллеги быстро находят ответы (в том числе через Ctrl+F), решают проблемы и разбираются в технологии: как следствие, увеличиваются их продуктивность и доход компании;

• для внешней документации: разгружает сотрудников техподдержки.

---

Хорошая ли у вас документация?

Пройдите маленький тест и посчитайте набранные баллы:

Результаты:

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

Не торопитесь переходить к действиям — сначала налейте чай и просто прочитайте статью.

---

Шаг 1. Соберите всю информацию

Давайте посмотрим, какой материал у вас уже есть. Для этого соберите все описания вашей технологии из разных источников:

• старая документация;

• личные страницы — ваши и коллег (например, в Confluence);

• ответы в чатах;

• репозитории (например, в GitLab);

• Word и другие текстовые редакторы;

• ссылки в закладках браузера.

На будущее: никогда не дублируйте инструкции в разных ресурсах, так их будет сложнее поддерживать: 

• легче обновить одну, чем две;

• одну из версий точно забудут обновить — и она будет вводить в заблуждение; как назло всегда будут находить именно её.

---

Шаг 2. Выбросите мусор

Одна актуальная статья лучше десяти устаревших.

Проверено: если у вас в документации найдут устаревшие сведения, никто не будет читать дальше — спросят у вас лично.

Самый важный шаг перед написанием документации — это избавление от устаревшей информации. Перечитайте всё, что собрали, и удалите неактуальные статьи, разделы и предложения. 

Под «избавлением» имеется в виду одно из двух:

• добавление в архив — предпочтительно;

• безвозвратное удаление.

Если после этого вообще ничего не осталось, это нормально.

Если вы детально не знаете начинку описываемой технологии

После такой «чистки» обычно очень легко дышится — будто камень с шеи снял.

---

Шаг 3. Найдите частые вопросы и сценарии

Наша новая задача — определить, что нужно задокументировать или актуализировать в первую очередь. Обычно это выясняется так:

1. Вы перечитываете все вопросы в чате за последний месяц, выписываете их на отдельную страницу (не удаляйте её) и считаете их количество. 

2. Читаете комментарии с вопросами под инструкциями, если есть.

3. Опрашиваете аудиторию. Обычно это либо пост в публичном чате, либо вопросы знакомому коллеге лично. Формы с опросами, как правило, неэффективны, поскольку собирают мало ответов.

4. Продумываете популярные сценарии с командой, ведь лучше вас продукт никто не знает.

Вначале выпишите вопросы и сценарии, а потом начинайте писать для них тексты.

Если вашей разработкой пока никто не пользовался, будьте готовы собрать обратную связь после релиза и дописать то, что было неясно.

---

Шаг 4. Поделите на разделы

Цель — наметить примерный план будущей базы знаний. Он может дополняться, когда появятся новые данные, но пока нужно сделать «скелет» для всего остального. 

Структура нужна, чтобы пользователю было понятно, в каком разделе искать нужную информацию. Это особенно актуально, если в вашей документации много страниц.

Добавить их все сплошным списком вразнобой — провальный вариант. Ctrl+F тут тоже не всегда поможет, потому что, например, вы пишете в названии страницы «кубер», а ваш читатель ищет «Kubernetes» или «k8s», ничего не находит — и идёт к вам в личку.

Целевая аудитория

Читатель должен видеть только то, что ему полезно. Разделяйте документацию в зависимости от потребностей аудитории.

Подумайте, какие люди будут её читать. Например:

• только ваша команда;

• другие команды, им нужна одна функциональность;

• другие команды, им нужна разная функциональность;

• и ваша команда, и другие команды.

Внешние команды не должны видеть странички «Черновик to do», «[убрать в архив] 2 декабря». Держите их в отдельной папке для черновиков.

Например, если ваша аудитория — продуктовые разработчики и команда мониторинга критичных сервисов, которые ищут в документации абсолютно разные вещи, разделите её соответствующим образом.

---

Шаг 5. Составьте словарь терминов

Одна сущность — один термин.

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

Термины должны легко находиться через Ctrl+F.

Если у вас в команде есть авторские разработки, названия которых придумали вы сами, заведите словарь терминов с пояснениями. Это особенно актуально, если статей много и неудобно в каждую добавлять расшифровки. Людям будет в разы проще вникнуть в вашу разработку: оставляете везде ссылку на словарь и радуетесь жизни.

---

Шаг 6. Утвердите правила для команды

Заранее обговорите с командой правила и план ведения документации.

• нет структуры — статьи добавляют куда попало;

• никто не убирает устаревшую информацию;

• команда не всегда знает, что у неё есть в документации;

• много заброшенных статей;

• много пустых статей из 2016 с пометкой «to do»;

• перемешаны внутренние черновики и внешняя документация;

• нет архива;

• ведётся на русском, английском, латинском и древнегреческом.

Донесите до команды, что документация — это ваш общий продукт и от её качества зависит эффективность: ваша и других команд.

Пример правил по созданию новых страниц:

Советую почитать о методике совместного ведения документации.

---

Шаг 7. Напишите тексты

Лучший способ научиться писать хорошие инструкции — это отдавать их на вычитку. Желательно — редактору. Если его нет — любому коллеге. Я не о проверке пунктуации, а о том, понятно ли написана статья, полная ли в ней информация.

Некоторые советы могут показаться сложными, но в них описаны базовые вещи.

• Освойте инструменты форматирования там, где вы ведёте документацию. Примеры: макросы Confluence, синтаксис Markdown и HTML.

  

• Укажите, для кого страница и что в ней описано, — тогда человек сразу поймёт, нужно ли ему это читать.

• Не пишите сплошные тексты — делите их на логические абзацы и разделы. При грамотной вёрстке легче сходу найти ответ.

• Добавляйте оглавление. Его цель — дать читателю возможность быстро понять, в какую часть текста ему нужно переместиться. Если оно получилось на сто пунктов, сократите его или разбейте статью на несколько.

• Оформите разводящую страницу. Это главная страница с основной информацией и разделами по темам. Она нужна, чтобы читатель быстро понял, где искать необходимую инструкцию.
  Пример Ozon Docs
  Пример Yandex Cloud
  Пример Amazon EC2

• Соблюдайте форматирование — не пишите весь текст в заголовке или жирным шрифтом, не создавайте таблицу в таблице, не убирайте весь текст под каты.

• Добавляйте ссылки на другие инструкции и сервисы, если они упоминаются в тексте. Это сильно экономит время читателей. Может, они найдут устаревший дубль из шага 1.

• Избегайте канцеляризмов — они утяжеляют тексты: «для того чтобы в данном процессе осуществить определённую функциональность».

• Выделяйте в тексте важное, но не превращайте его в одни сплошные плашки.

• Укажите контакты команды, чтобы читатели знали, к кому обращаться.

---

Шаг 8. Добавьте FAQ

FAQ — страница с часто задаваемыми вопросами и ответами на них. 

Многие технические писатели считают наличие FAQ признаком плохой структуры документации. Я же советую добавить эту страницу, потому что она может спасти ситуацию, если у вас не очень удачная разводящая страница.

Используйте список из шага 3, если он есть.

FAQ — это не полноценная инструкция. Не дублируйте тексты и не делайте ответы очень подробными. 

Оптимальный вариант — краткий ответ со ссылкой на полную инструкцию. Например, «Да, это возможно. Подробнее в статье “Как создать N”».

Для продвинутых идеалистов:

Вопросы можно сгруппировать по темам — так их будет проще найти. Такие страницы FAQ обычно очень нравятся разработчикам, но это не принципиально, потому что обычно вопросы ищут с помощью Ctrl+F.

---

Шаг 9. Продумайте, как вашу документацию будут находить

Чтобы ваши труды не пропали даром, вашу документацию должно быть легко найти. 

Подумайте, куда ваши коллеги чаще обращаются за помощью:

• к вам в личку: закрепите ссылку на документацию у себя в профиле на корпоративном портале;

• в ваш чат: закрепите ссылку в шапке, закреплённом сообщении, сделайте так, чтобы каждому вступившему ссылку отправлял бот;

• в поиск Confluence: удалите устаревшую информацию, если ещё этого не сделали, чтобы она не всплывала, понятно называйте статьи.

Уведомите аудиторию, что у вас появилась документация, вы за ней следите и обращаться нужно именно туда. 

---

Шаг 10. Проанализируйте результат

Лучший источник для анализа — ваша аудитория. 

Есть несколько способов понять, решает ли проблемы ваша документация.

Что обычно делаю я:

• Считаю количество запросов в чатах. 

• Провожу мини-исследование среди читателей: готовлю открытые вопросы, спрашиваю, долго ли они искали информацию, что именно они искали, нашли ли ответы на свои вопросы.

• Изучаю статистику просмотров в Confluence и Grafana: если за месяц никто не обратился к документации, нужна ли она?

Сама не практикую, но отличная идея:

• Добавить фичу «Оцените статью». Такие макросы точно есть в Confluence.

Если на этом этапе не всё гладко — это нормально, просто будьте готовы что-то дописать, поменять местонахождение статьи.

---

Итог

Наверное, достаточно информации за раз. Посоветуйтесь с командой, решите, нужна ли вам документация, есть ли ресурсы для её разработки и поддержки.

И помните, что документация — ваш общий продукт. 

Буду рада ответить на ваши вопросы. Делитесь мнением и историями в комментариях.

Как правильно подобрать линзы

Мягкие контактные линзы (МКЛ) — это оптические средства, которые надевают на роговицу для коррекции зрения или с целью изменить цвет глаз.

Правильно подобрать подходящие контактные линзы для коррекции зрения может только офтальмолог. При подборе оптики специалист учитывает следующие факторы:

• Диагноз;
• Функциональные характеристики МКЛ (оптическая сила, диаметр, кривизна);
• Условия использования;
• Предпочтения пациента (срок ношения, стоимость).

Опираясь на указанные параметры, окулист сможет подобрать подходящую конкретному пациенту оптику. Вы не сможете самостоятельно определить верный срок ношения, материал, кислородопроницаемость и другие характеристики. Сделать это в силах только офтальмолог. Даже если самостоятельно подобранные МКЛ не доставляют дискомфорта во время носки, они могут навредить вашему зрению.

Пройти офтальмологическое обследование и подобрать контактную коррекционную оптику можно в клинике ЭЛИТ ПЛЮС. В медцентре используется современное оборудование, с помощью которого вам подберут правильные линзы.

Виды МКЛ

Среди разнообразия контактных линз нет специальных моделей для новичков. Подбор оптики не зависит от того, впервые ли пациент надевает ее или уже пользуется долгий период времени. Классификация коррекционной оптики зависит от следующих характеристик:

• Дизайн — сферические, торические, мультифокальные. Форма изделия зависит от диагноза, например пациентам с миопией окулист назначает сферические МКЛ;
• Материал — гидрогелевые и силиконгидрогелевые. Оба варианта различаются по уровню газопроницаемости и содержанию влаги;
• Оптическая сила — с диоптриями и эстетические. Многие люди с хорошим зрением любят носить цветные МКЛ без диоптрий, чтобы изменить или подчеркнуть цвет глаз. Им также необходимо знать, как правильно надевать линзы;
• Режим ношения — дневные, пролонгированные. Большинство МКЛ рекомендовано носить только днем, не более 12 часов. Существуют варианты изделий, которые по рекомендации доктора можно носить не снимая до месяца;
• Время замены — однодневные, еженедельные, ежемесячные, трехмесячные, полугодичные. На изделиях, которые используются наименьший период времени, накапливается минимальное количество бактерий. 

Перечисленная классификация относится к мягким контактным линзам. Для лечения прогрессирующей близорукости используются более современные методики, например ортокератологические линзы ночного ношения. С их помощью можно не только остановить развитие патологии, но и вернуть пациенту стопроцентное зрение. 

ПЕРВИЧНАЯ КОНСУЛЬТАЦИЯ

Подготовка к ношению линз

Если вы раньше никогда не использовали контактные средства коррекции зрения, безусловные рефлексы глаза будут мешать установке постороннего предмета. Это выражается в автоматическом закрывании века при попытке надеть МКЛ. Поэтому, прежде чем устанавливать оптическое изделие, необходимо подготовить роговицу:

• Перестаньте боятся — в использовании контактной оптики нет ничего страшного;
• Перед надеванием МКЛ потренируйтесь — аккуратно дотрагиваясь кончиками пальцев до белков глаз, постепенно зрительный орган привыкнет и не будет негативно реагировать на посторонние предметы;
• Определитесь, на какой глаз первый вы будете надевать оптику — этот совет особенно актуален для пациентов с разной степенью патологии;
• Соблюдайте гигиену — надевать линзы нужно всегда чистыми руками;
• Изучите обучающие видеоролики и прочтите специализированные статьи.

Как правильно надевать линзы?

Возьмите себе за правило всегда первой надевать МКЛ на левый или правый глаз, особенно если используете изделия с разными диоптриями. Правильно надевать линзы так: 

• Подготовьте контейнеры с оптическими средствами коррекции зрения, флакон со специальной жидкостью для хранения и пинцет с силиконовыми накладками;
• Вымойте руки с мылом и насухо вытрите безворсовой салфеткой (необходимо исключить попадание на поверхность изделия ворсинок, ниток или других микрочастиц);
• Вскройте блистер с изделием и аккуратно возьмите его специальным пинцетом;
• Положите МКЛ на указательный палец ведущей руки и убедитесь, что она находится в правильном положении (не вывернута наизнанку);
• Проверьте коррекционную оптику на наличие трещин, царапин, налета или иных повреждений;
• Средним пальцем руки, которая держит линзу, оттяните нижнее веко, а указательным пальцем другой руки приподнимите верхнее;
• Установите МКЛ в глаз и поморгайте.

Если вы все сделали правильно и на изделии не было посторонних предметов (или между линзой и глазом), чувство дискомфорта будет отсутствовать. Первые несколько минут новички будут ощущать инородное тело, но это чувство быстро пройдет.

В некоторых случаях при неправильном надевании МКЛ она смещается, и пациент видит предметы нечетко. Тогда необходимо провести центровку. Для этого аккуратно сдвиньте линзу в нужное направление, не надавливая сильно на глаз. Сделать это можно при опущенных или поднятых веках.

Как правильно снимать линзы

Хранить МКЛ необходимо в контейнерах, заполненных специальным раствором. Жидкость менять необходимо ежедневно. Перед снятием изделий необходимо вымыть руки и насухо протереть. Извлекать оптические средства рекомендуется в той же последовательности, в которой надевали. Инструкция по снятию контактной оптики:

• Проверьте, чтобы линза была расположена строго по центру глаза;
• Посмотрите вверх, оттяните нижнее веко и указательным пальцем потяните изделие вниз или к переносице;
• При смещении оптическое средство не так плотно будет прилегать к глазному белку, поэтому вы легко образуете на нем складку с помощью большого и указательного пальцев;
• Аккуратно извлеките МКЛ.

Храните изделия всегда в свежей жидкости и в отдельных контейнерах. Это не даст скапливаться на поверхности вредоносных бактерий и налета, а значит исключит развитие воспалений.

Проблемы при использовании

Чтобы использование коррекционной оптики не приносило дискомфорта необходимо соблюдать гигиену. Важно ежедневно менять раствор в контейнерах для хранения МКЛ. Также нужно соблюдать сроки ношения изделий. Запрещено надевать поврежденную оптику. Это не только будет доставлять дискомфорт пациенту, но и может стать причиной развития воспалительных процессов.

Помните, что самостоятельно подобрать контактную оптику невозможно. Этим должен заниматься офтальмолог. Только специалист сможет правильно подобрать оптическую силу и другие параметры.

Источник: https://elitplus-clinic.ru/stati/kak-nadevat-linzyi.html

Аэропорт для новичка. Инструкция для тех, кто летит на самолете первый раз

Наконец вы дождались отпуска и летите отдыхать. Только вот лететь на самолёте вы будете в первый раз… И тут у вас возникает миллион вопросов: что делать в аэропорту? Куда идти? Как не опоздать на рейс?

Мы решили сделать небольшой FAQ по терминам и процедурам, который поможет новичкам чувствовать себя немного увереннее в аэропорту.

Порядок может немного меняться, так как в каждом аэропорте своя последовательность прохождения досмотров и регистрации.

Попав в аэропорт, первым делом вы должны пройти регистрацию на рейс (англ. check-in). Над стойкой регистрации,  висит табло с логотипом авиакомпании, номером рейса и городом прибытия.

Данная информация продублирована на информационном табло, там же указан номер стойки, где проходит регистрация на ваш рейс.

Регистрация начинается за 2 часа до вылета и заканчивается за 30-40 минут до вылета.

При регистрации вы должны предъявить паспорт и авиабилет. Если у вас электронный билет, то предъявляете только паспорт. Багаж вы должны положить на транспортную ленту, где его взвесят, повесят специальную бирку (чтобы грузчики знали в какой самолет его положить, а вы смогли его потом найти) и отправят грузчикам. Также вас попросят предъявить ручную кладь (вещи, которые вы хотите взять с собой в салон самолета), на нее тоже могут повесить бирку.

Как правило, вес ручной клади не должен превышать 7-10 кг. Кроме этого, есть определенные требования к габаритам сумки, их вы можете уточнить у авиакомпании.

После регистрации вам выдадут посадочный талон (анг.  boarding pass) и багажные бирки (наклейки, которые клеят на паспорт или посадочный талон, они помогут вам найти ваш чемодан по прилету).

Зарегистрироваться можно не только в аэропорту, но и дома. Некоторые авиакомпании практикуют онлайн регистрацию на рейс. Зарегистрироваться таким образом можно с помощью ноутбука, планшета и даже телефона. Подробнее о мобильной регистрации, можно почитать в посте “Мобильная регистрация”. После чего на обычном принтере, вы распечатываете посадочный талон, а багаж сдаете на специальной стойке Drop off.

На посадочном талоне будет написано в каком гейте будет посадка на самолет и ваше место в салоне. При регистрации, вы можете попросить представителя авиакомпании посадить вас на удобное место, например у окна или возле аварийного выхода.
Гейт (анг. gate – ворота) – выход на посадку к вашему самолету.

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

Обратите внимание, что во время прохождения  досмотра, на вопросы сотрудников службы  безопасности об имеющихся у вас предметах и веществах,  не следует допускать шуток, например, «это бомба», «это наркотики» и т. д. Подобные ответы рассматриваются как заявление пассажира о наличии у него опасных веществ и предметов и могут повлечь за собой снятие  с рейса, и проведение дальнейшего разбирательства и привлечения к ответственности в соответствии с законодательством РФ вплоть до возбуждения уголовного дела по ст. 207 УК РФ («Заведомо ложное сообщение об акте терроризма»).

На международных рейсах, перед регистрацией все пассажиры должны пройти таможенный контроль. Во время его прохождения вы увидите два коридора: «красный» и «зеленый». Они обозначаются надписями на русском и английском языках: “Товаров, подлежащих обязательному письменному декларированию, нет” (Nothing to declare) для зеленого коридора и “Товары, подлежащие обязательному письменному декларированию” (Goods to declare) для красного коридора.

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

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

После прохождения этих формальностей, вы попадете в зал ожидания, где расположены кафе и  дьюти фри  (англ. Duty Free) – магазины беспошлинной торговли.

Когда объявят посадку на ваш рейс (англ. boarding), вернитесь к вашему гейту и предъявите посадочный талон и паспорт (он не всегда требуется) представителю авиакомпании. У посадочного талона справа имеется отрывной корешок, на котором дублируется основная информация. Представитель авиакомпании его оторвет и отдаст вам. Сохраняйте талон до тех пор пока не получите багаж по прилету.

Посадку объявляют несколько раз по громкоговорителю, эта же информация продублирована на информационном табло и над самим гейтом.

Если вы заблудились, то подойдите к любому служащему аэропорта и вам помогут найти нужный гейт.

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

То, что будет происходит на борту самолета не менее интересно, поэтому советуем вам прочитать нашу статью “Зачем и почему на борту самолета”. Она ответит на большинство ваших вопросов, например, почему закладывает уши при взлете и посадке, зачем выключать мобильные телефоны и многое другое.

По прилету, вас снова посадят на автобус или по мосту вы попадете в зал прилета аэропорта, там вы  пройдете паспортный и таможенный контроль и заберете багаж.

Если вам предстоит рейс с пересадкой, то прочитайте нашу статью “Пересадка в аэропорту”. В ней мы ответим на самые популярные вопросы о пересадке.

Покупайте дешевые авиабилеты на сайте Kupibilet.ru!

А в нашем Телеграм-канале тоже есть полезная и актуальная информация. Рассказываем о местах, куда сразу же хочется улететь, публикуем дешёвые билеты и рассказываем новости. 

29 Mar 2012          Метки: аэропорт, летим первый раз    

Если кроме использования и настройки, программное обеспечение предоставляет возможность написания, редактирования или использования программного кода. Какой документ необходим в этом случае?

Назначение руководства программиста

Руководство программиста относится к эксплуатационно-технической документации и требуется в тех случаях, когда система тем или иным образом предоставляет возможность написания, редактирования или использования программного кода.

Примерами могут служить:

– библиотека функций;

– платформа или среда для разработки ПО;

– ПО с открытым кодом.

Документ должен предоставлять всю необходимую информацию для того, чтобы разработчик мог воспользоваться возможностями системы. Для решения этой задачи содержание документа может включать в себя:

– назначение, структуру входных и выходных данных программных функций;

– возможности по созданию программного кода, особенности его интерпретации и компиляции;

– синтаксические особенности используемого языка программирования;

– возможные правила и ограничения при работе с программным кодом;

– различные инструкции по работе с программой.

Список возможных тем этим не ограничивается, все зависит от особенностей конкретной системы. Надо сказать, что руководство программиста бывает очень полезно и для разработчиков системы, являясь справочником по текущей реализации логики работы ПО.

Состав типового руководства программиста

В соответствии с требованиями ГОСТ руководство программиста должно содержать следующие разделы:

– Назначение и условия применения программы, где указывают область применения ПО и технические требования, необходимые для его работы.

– Характеристика программы, где описывают режим работы программы, показатели скорости ее работы и другие важные для использования характеристики.

– Обращение к программе, где указывают способы и параметры запуска программы;

– Входные и выходные данные, где описывают формат, способ организации и другие требования к входным и выходным данным;

– Сообщения, где приводят тексты сообщений, выдаваемых программой в различных ситуациях и действия, которые необходимо при этом предпринять.

Различные примеры, иллюстрации и таблицы целесообразно приводить в приложениях к документу.

Стандарты для руководства программиста

ГОСТы регламентируют и этот документ, в данном случае это ГОСТ 19.504. В соответствии с ним определяется структура и содержание Руководства программиста.

Стоимость разработки руководства программиста

Наименование документа	Наименование стандарта	Стоимость разработки
Руководство программиста на ПО	ГОСТ 19.504	100 тыс. р.

Работа по созданию руководства программиста требует высокой квалификации специалиста и знаний в области программирования, однако, для профессиональных разработчиков такая работа обычно представляется скучной и нудной, к тому же, требует умения грамотно формулировать и доступно доносить материал. Специалисты ТехРайтКонсалт обладают большим опытом в обеих областях, что позволяет нам создавать документы по доступной цене и точно в срок!

Возможно, вас также заинтересует:

– разработка руководства администратора;
– создание руководства пользователя;
– разработка руководства оператора.

---