Гарантия возврата
Вернем деньги, если что-то пойдет не так.
Константин Макаров
Константин
Верифицированный пользователь
Чат откроется после оплаты
Стоимость услуги
65 000 rub

Срок выполнения

21 день

Гарантия возврата
Вернем деньги, если что-то пойдет не так.
Константин Макаров
Константин
Верифицированный пользователь

Чистая документация для разработчиков: от требований до хелпа

Создаю и привожу в порядок техническую документацию для IT-продуктов: API, внутренние гайдлайны, README.md, пользовательские мануалы. Делаю так, чтобы разработчики и клиенты понимали ваш продукт без тысяч вопросов в поддержку. Работаю в форматах Markdown, Confluence, GitBook и других. Что входит в услугу? -Технические гайдлайны -Onboarding для новых разработчиков (как запустить проект, деплой, тесты). -Стандарты кодинга, код-ревью, принципы архитектуры. -Пользовательская документация -Руководства для SaaS-продуктов (админка, настройки, FAQ). -Troubleshooting и «Как решить частые ошибки». -Системная документация -Security-требования и compliance (например, для GDPR). Для кого: -Команды, где документация «живет в головах» и нет времени ее структурировать. -Стартапы, которые масштабируются и теряют контроль над knowledge base. -Разработчики API/SDK, чьи клиенты жалуются на непонятные интеграции. Проблемы, которые решаю: -Документация устарела после третьего коммита и никто не ведет актуализацию. -Клиенты или новые разработчики постоянно спрашивают одно и то же. -Инструкции написаны «для себя» и непонятны внешним пользователям. Объем услуги: -Создание документации объемом до 30 страниц А4 или 75 тыс. символов. -Редактирование уже существующей документации объемом до 30 страниц или 75 тыс. символов.

Заказчик получит:

Все необходимые документы. Гайдлайны. Рекомендации по ведению.

До начала работы заказчик должен предоставить:

Информация о текущей документации. Первичное интервью для ознакомления с текущей документацией.