История изменений
Исправление Nervous, (текущая версия) :
документация не должна выходить за пределы обзора крупных архитектурных сущностей (карта местности) и подсказок о неочевидных особенностях (минные поля)
Собственно, как раз то, о чем был плач (что каждому новому человеку нужно рассказывать устные былины о проекте, иначе он заблудится в архитектуре).
Я думаю, еще как минимум не помешает раздел Getting started.
доступ к сорцам есть, а значит тотальное документирование непродуктивно.
Тотальное и не нужно. Для деталей реализации есть комментарии и докстринги. Но хотя бы публичные интерфейсы-то можно кратко описать?
Исправление Nervous, :
документация не должна выходить за пределы обзора крупных архитектурных сущностей (карта местности) и подсказок о неочевидных особенностях (минные поля)
Собственно, как раз то, о чем был плач (что каждому новому человеку нужно рассказывать устные былины о проекте).
Я думаю, еще как минимум не помешает раздел Getting started.
доступ к сорцам есть, а значит тотальное документирование непродуктивно.
Тотальное и не нужно. Для деталей реализации есть комментарии и докстринги. Но хотя бы публичные интерфейсы-то можно кратко описать?
Исходная версия Nervous, :
документация не должна выходить за пределы обзора крупных архитектурных сущностей (карта местности) и подсказок о неочевидных особенностях (минные поля)
Собственно, как раз то, о чем был плач (что каждому новому человеку нужно рассказывать устные былины о проекте).
Я думаю, еще как минимум не помешает раздел Getting started.