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

С уважением, Галина

Спасибо