фигма кайфовая, жаль я в ней не работаю

Во имя сатаны, конечно!

Почти)

SO CLOSE

SATANIC GET

кстати у приватбанка это статус) но что-то слово не то кажется
https://api.privatbank.ua/#p24/balance

обязательность?

Вообще вопрос - а нужны ли заголовки? Когда пишешь по стандартам или какие-то иные требования, то ок. Но без этого заголовки просто принято писать, а нужность их определяется тем, понятно ли. Может же быть понятно и без придумывания названий для перечисляемых сущностей. Вот в этом примере читатель что, запутается? Решит, что required это название? Или описание? Вроде же ясно, что это некое свойство, в данном случае означает, что этот параметр обязателен. Название с описанием тоже не перепутаешь. Несёт ли какую-то функцию эта строка с заголовком или просто занимает место и вынуждает придумывать всякое, на что и смотреть никто не будет?

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

тогда казалось что он нужен. сейчас, когда добавили еще четвертый столбик — то кажется вроде и так понятно что есть где

Ну я же не категоричен) просто на подумать. Консистентность это круто, но ситуации действительно разные бывают. Если вы всё формализуете, то от ультимативных решений не уйти, придётся всё подгонять под один вид, даже там, где это стремно и не нужно... но с другой стороны если делать по-разному от ситуации то такая каша будет. Но кто её увидит? Уверены ли вы что ваши читатели вникают в документацию как в Библию, разбирая каждый момент последовательно? Ведь только так им будет мешать эта каша. Скорее всего же читатели «пользуются» документацией ситуативно и никого не будет смущать, что в одном контексте оформлено более лёгким образом, потому что и так понятно, а где-то оформление более строгое, чтобы избежать неоднозначности. Не кажется ли, что каша в таком случае даже преимущество?

Вот кстати огромный плюс документации по ГОСТу. Там таких решений принимать не надо. Везде всё под одну гребёнку и не паришься

Коллги, поделитесь опытом, в каких программах ведете пользовательскую документацию по продукту с возможностью отслеживания изменений и версионностью😊🙏🏻

Git, GitHub :)
https://github.com/tarantool/doc

BitBucket

В общем и целом — смотрите на docs as code :)

Начать можно с наших с @kvaleev лекций из курса Documentat.io

Довольно незнакомая вещь) может знаете ресурсы по легкому входу в эту тему? и возможно ли уже имеющуюся документацию преобразовать?

Спасибо!)