@equinsuocha
QA

Как научиться документировать?

По долгу службы нужно исследовать продукт и создавать некую документацию (диаграммы зависимостей, блок-схемы и т.п.). К счастью или сожалению, не имею профильного инженерного образования и опыта создания документации. Делаю по наитию и в целом даже понятно для окружающих (документы создаются исключительно для лучшего понимания, не входят ни в какую отчетность и т.п.). Формальная сторона вопроса ни меня, ни моих коллег не интересует, но мне иногда кажется, что стоит открыть для себя некий пласт систематизированных знаний и инструментов в данной области, который облегчит жизнь мне и окружающим, а также станет плюсиком в моем резюме.
Отсюда вопрос, как правильно подступиться к вопросу? Кто знает годную литературу (англ, рус), которая освещает вопрос в целом, не касаясь глубоко конкретных средств моделирования? Я понимаю, что можно просто взять и изучить UML, но сейчас мне он с практической точки зрения кажется не очень удобным, избыточным, т.к. я в принципе документирую выше уровня классов.
  • Вопрос задан
  • 216 просмотров
Пригласить эксперта
Ответы на вопрос 1
@Vicom
что Вы документируете? от этого во многом будет зависеть ответ

даже в обычном ТЗ масса доп. разделов к каждому из которых (лично моё мнение) до сих пор разрабатываю уникальные концепции, подходы (исходя из архитектуры проекта, используемых технологий и того, что конкретно и в какой форме должен выразить для читателя максимально понятно с минимальными пояснениями с моей стороны)
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы