Привет!
Есть сервис, который очень круто и быстро развивается. По нему возникает много моментов, которые лучше всего документировать, чтоб в последующем, как пример, не тратить уйму времени на выяснение принципа работы алгоритма сортировки и группировки данных в таблице, с учётом того, что по некоторым данным должны выводиться графики, если это удовлетворяет внутренним условиям — это пример!
Очень хочется услышать практику от людей, которые занимаются внутренним документированием функционала и прочего смежного, а так же возможно покрывающие функционал для внешней документации.
В идеале будет, если это какой-то сервис, но и stand-alone варианты так же рассматриваются.
Для небольшой команды (до 5 человек) можно попробовать в работе Confluence от Atlassian https://www.atlassian.com/software/confluence. Облачная версия будет бесплатна. А так, подойдет любая wiki-подобная система. Главное в этом процессе не используемое ПО, а качество работы с документацией. Ее всегда необходимо поддерживать в актуальном состоянии.
Вы не указали конкретные требования. Без этого любые советы - бесполезны.
Например:
- требуются фичи A, B, C.
- документация будут пользоваться H, K, L
- время на постановку процесса/возможная стоимость - S.
P.S. Confluence - не рекомендую. Это средство для collaboration, а не technical documentation!
Простой
Простой
