Документация 101: создание хорошего файла README для вашего программного проекта

Наличие хорошей документации для вашего проекта с открытым исходным кодом является важной (и часто упускаемой из виду) функцией, которая способствует принятию и демонстрирует весь потенциал того, что пользователи могут сделать с вашим приложением или библиотекой.

К сожалению, документация часто растет гораздо медленнее, чем код, главным образом потому, что некоторые реализации, которые выглядят довольно простыми, могут порождать огромное количество возможных вариантов использования и вариантов того, как что-то делается в приложении или библиотеке. Никогда невозможно охватить все возможные сценарии, поэтому первая задача технического писателя — определить масштаб и расставить приоритеты. Очень важно сосредоточиться на том, что является важным знанием и должно быть задокументировано в первую очередь для поддержки наиболее распространенных вариантов использования.

В этой статье, я поделюсь некоторыми советами по созданию хорошего файла README для вашего проекта.

https://shly.link/devZSpY