перевести документацию проекта на простые форматы

[osiyuk]

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

документация должна быть простой и не должна требовать специфичных программных продуктов, как пример, формат vsd требует microsoft visio.

если этот репозиторий находится в github, то хорошим форматом является markdown
все схемы можно хранить в графических форматах, например, png
для прототипа графического интерфейса лучше использовать непосредственно html, либо markdown

[sedovalx]

Некому этим сейчас заниматься. Можешь попробовать объяснить все @hodkoff2 и вместе что-то сделать в плане документирования.

[hodkovdd]

@osiyuk

Я готов обсуждать, с чего начать?

[osiyuk]

@hodkoff2

Нужно сделать скриншоты всех интерфейсов. Я по скриншотам соберу прототип на чистом html. Прототип можно будет открыть в браузере без какого-либо сервера и пробежаться по всему интерфейсу. На основе прототипа можно будет собрать граф.

[hodkovdd]

Скриншоты это с меня? Если да, то какие требования? разрешение, окно целиком или его части, прочее...
И для неучей - что за граф и зачем он?

[osiyuk]

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

Граф ссылочный. Широко используется для решения аналитических задач.
https://ru.wikipedia.org/wiki/%D0%93%D1%80%D0%B0%D1%84_%28%D0%BC%D0%B0%D1%82%D0%B5%D0%BC%D0%B0%D1%82%D0%B8%D0%BA%D0%B0%29