Документация библиотеки и приложения
Вы можете увидеть подробную документацию для фундаментальных API, которая повторяет имена и сигнатуры типов. Стабильный и широко используемый код может позволить себе это при положительной окупаемости.
-
Код библиотеки:
- имеет большое число пользователей,
- решает целый ряд связанных задач,
- часто имеет стабильные API.
-
Код приложения — наоборот:
- мало пользователей,
- решает конкретную задачу,
- часто меняется.
-
Вы, возможно, видели подробную документацию, которая повторяет код, многократно рассматривает один и тот же API с множеством примеров и разборов. Контекст имеет решающее значение: кто её написал, для кого, какой материал она охватывает и какими ресурсами располагали авторы.
-
Фундаментальный библиотечный код часто имеет подробную документацию, например стандартная библиотека и многократно переиспользуемые фреймворки вроде Serde и Tokio. Команды, отвечающие за такой код, обычно имеют ресурсы, чтобы писать и поддерживать подробную документацию.
-
Библиотечный код часто стабилен, поэтому сообщество извлекает значительную пользу из подробной документации до того, как её придётся переделывать.
-
Код приложения обладает противоположными свойствами: у него мало пользователей, он решает конкретную задачу и часто меняется. Для кода приложения подробная документация быстро устаревает и начинает вводить в заблуждение. Даже пока она актуальна, извлечь положительную окупаемость из шаблонной документации трудно, потому что пользователей мало.