TGViewer
Уютный IT адочек Уютный IT адочек @lovely_it_hell · 3.57K subscribers
Post #96 125

Forwarded from DocOps

Как выстроить разработку внутренней документации

Игорь @i_tsupko спрашивает в чате @docsascode:

Проблема: есть пара-тройка человек, которые пополняют внутреннюю базу знаний. И каждый тянет одеяло на себя, не могут договориться о том как структурировать доки, как делать меню, навигацию и прочее.

Как договориться? В программировании для этого есть фреймворки и паттерны. А с русским языком как быть? Он ж не компилируется и автотесты не напишешь.

Что важно в документации:

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

У вас тоже это болит? Знаете решение? Приходите в @docsascode, обсудим.
More from @lovely_it_hell
  1. Oct 13, 2026Как обновить кластера kubernetes? Всего три простых шага, записывайте: 1. Уничтожаем стары…
  2. Oct 9, 2026Записал вам пару шортсов о проблеме агентной памяти и заходах на решение • https://www.you…
  3. Oct 7, 2026Давайте быстро напишем своего AI-агента! Это новый вариант фразы "давайте быстро сделаем с…
  4. Oct 5, 2026photo post
  5. Oct 3, 2026Нанять product engineer легко. Гораздо сложнее перестать согласовывать с семью людьми кажд…
  6. Oct 2, 2026Post #718
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →