TGViewer
Technical Writing 101 🇺🇦 Technical Writing 101 🇺🇦 @technical_writing · 1.45K subscribers
Post #606 2.51K
Информативный пост написанный по мотивам Knowledge Conf-доклада Семёна Факторовича, руководителя documentat.io о чувстве «бесполезности» документации (и не только).

>Чаще всего за словом «бесполезна» кроется ощущение, что документация не очень хорошо выполняет свою задачу. Потому что она либо не полна, то есть описывает не все аспекты, которые хотелось бы в ней найти. Либо не точна, то есть то, что в ней написано, не полностью соответствует истине. Либо не актуальна, то есть соответствовала истине в прошлом, а сейчас программная система или внешний мир изменились, и документация перестала этому соответствовать.


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

❗️Наша редакция уважает Семёна и рекомендует статью к прочтению.

🔗 Читать: Вам кажется, что с вашей документацией что-то не так? Вам не кажется

#article #ru
Хабр Вам кажется, что с вашей документацией что-то не так? Вам не кажется Меня зовут Семён Факторович, с 2012 года я занимаюсь технической документацией. Последние три года я руковожу собственным агентством documentat.io , помогая российским IT-компаниям создавать...
  • ❤ 1
  • 👍 1
  • 🤯 1
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 →