Как документировать функционал?
7 февраля 2017 в 23:38
Кто и что использует на небольших и средних проектах для документирования функционала и краткой помощи пользователям по работы с их проектом?
Понятно, что бюджет тут не всегда позволяет писать и издавать обширные мануалы. Зачастую пользователи и сам разработчик через пару месяцев забывает зачем нужны какие-то настройки, поля и словари.
- Блог
- Войдите или зарегистрируйтесь, чтобы отправлять комментарии
Комментарии
Через месяц после полного курса обучения, админ напрочь забывает наши хитрые финты ушами.
И. Приходит к мысли, что проще платить за систематические ненавязчивые консультации (Во время которых, разумеется бесплатно, проводится обновление, лёгкий аудит и настройки).
Охота, с которой люди платят - иногда даже подозрительна ))
Мануалы полезны, но до той поры пока админ сам себе хвост не прищемит. Тут уже надо его выпутывать а не бросать ссылки.
Поэтому, я считаю так - проект или должен быть под плотным покровительством, или же - полное досвидание.
Очень интересная тема. Подпишусь почитать.
Сам, признаться, редко записываю за собой - попросту, из-за лени. Но задумывался не раз о необходимости.
Когда уже просят - стараюсь составить ридми, и на его основе более раскрытую версию со скринами.
Помимо коментов в коде, в гитлабе/битбакете пишу ишьюхи и веду вики.
Пару раз писал в ворде подробные инструкции со скринами. Некоторые ещё видео снимают, как пользоваться.
*.md - полностью устраивает
manual.md - для клиента
developing/*.md - для себя
Когда то давно, искал инструмент, который бы в полуавтоматическом режиме, по кликам в админке лог оформлял, но ... не нашел
а тема полезная.
Сильно зависит от клиента и рынка.
Бюджетным - надо делать стандартные инструкции и сборки.
Энтерпрайзу - там даже в смете обычно есть составление приемо-сдаточные испытания и документация отдельным пунктом.
Все что между - хороший кейс делать короткие видео. Сильно экономит время. 4-5 видео-роликов по 3-10 минут каждый может сэкономить часы документации и пояснений.
- Использовать по месту #description и комментарии
- Использовать hook_help
- README
P.S. Контекстная помощь удобней всего.