стайлгайд
Он же «Руководство по стилю (документирования)».
Желательный документ даже для одного человека, потому что упрощает поддержание единообразия в конкретном проекте или группе проектов.
В светлом и недостижимом идеале все правила стайлгайда превращаются в правила для линтера.
Не нужно писать всё вообще всё. Нужно писать принципы + всё, что вызывает сложности, сомнения и разногласия. По мере обнаружения, что вот тут имеет значение такой-то принцип. Вот тут посомневались и решили, что…
К правилам желательны объяснения. В чём проблема, почему так лучше.
Чужие стайлгайды, редполитики и подобное — полезны как источник сведений о том, как может быть, на этапе исследования. А вот цельнотырить скорее вредно — важен не только документ, но и процессы применения и изменения. Они к документу не прилагаются, а и если б прилагались, не факт, что подошли бы.
Задать cитуации, когда стайлгайд перечитывается.
- https://developers.google.com/style/
- https://learn.microsoft.com/en-us/style-guide/welcome/
- https://docs.ozon.ru/styleguide/
- Еще в открытом доступе есть стайлгайды для медиа: http://rdpk.ru/
- и где-то был госуслужный.