Мотивации и шаблоны
Четкая и краткая документация предоставляет участникам руководство по использованию и управлению вашим проектом. Это краткое руководство должно помочь вам написать отличные README для ваших проектов.
Шаблоны
Простой
Передовой
техническое обслуживание
README следует часто обновлять, основываясь на общих вопросах, возникающих при повторном посещении проекта участниками.
Вывод
Предоставление документации может сэкономить участникам, командам и компаниям значительное количество времени и энергии. README — это только начало пути к документации, и дополнительная документация, такая как IEEE 830–1998, может оказаться полезной для соблюдения системных требований. Для получения дополнительной информации, связанной с созданием приятного опыта для авторов, посетите Руководство по открытому исходному коду.
