Этап
Открыта
Тип
Задача
Приоритет
Низкий
Трудоемкость
Обычная
Создана
Дата создания
4 года назад
Назначена
Обновлена
год и 4 месяца назад

Хороший проект должен заключать в себе же всю необходимую документацию и правку. Сейчас, в рамках tndt-8 мы добавим справку, которой действительно не хватает единственному пользователю проекта, т.е. мне. А именно справку по использованию markdown. Но в будущем хотелось бы иметь как минимум систему справки по всем основным страницам, и полноценную документацию.

С одной стороны есть смысл держать её вместе с кодом. С другой раз у нас уже есть документация в такс-треккере, держать её здесь. Хорошим решением этого дуализма будет держать и записывать её здесь, а после пояления интеграции с git и полноценных сервисов документации, иметь кнопку при релизе сбрасывать актуальное на момент релиза состояние в коммите в код, в директорию help, в том же самом md. Тогда и на гитхабе проект будет уже с документацией, причем для каждого релиза своей, а здесь будет самая актуальная документация.

Задача конечно низкоприоритетная и касается наведения красоты, когда важные задачи уже решены.

Панель управления

Комментарии могут оставлять только авторизованные пользователи
 demius год и 4 месяца назад

В рамках tndt-169 мы немного актуализировали документацию и сделали её более структурированной. Надо бы сделать под неё контроллер и ссылку, чтобы смотреть прямо в проекте.