TGViewer
Technical Writing 101 🇺🇦 Technical Writing 101 🇺🇦 @technical_writing · 1.45K subscribers
Post #460 2.07K
Очень (очень!) хорошая статья от Nuclino о том, почему никто не читает документацию, почему это нормально и варианты разрешения этой ситуации. Nuclino сами занимаются разботкой софта для Обмена Знаниями, такой себе аналог Notion, поэтому они знают о чем говорят.

Статья написана просто прекрасно, еще и без запихивания рекламы своего продукта глубоко всем нам в горло.

Ключевые моментики из статьи:

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

Бонусный трек: их же статья про ценность документации и сколько может стоить отказ от обмена знаниями.

#article #en #resource
More from @technical_writing
  1. May 14, 2025📊 State of Docs 2025 is here! The State of Docs 2025 report just dropped — super interest…
  2. Jul 17, 2024🚀 Exciting update for technical writers and developers using Google Docs! 📝 Now, you can…
  3. Jun 26, 2024photo post
  4. Jan 27, 2023environmental documentation
  5. Dec 23, 2022Есть чувство, шо GitHub вот-вот перевернет рэп игру своей новой функцией Blocks. Blocks ー…
  6. Dec 22, 2022Допомоги/Підтримки пост Гайз, хочемо поділитись з вами штучним інтелектом який може створи…
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 →