TGViewer
Technical Writing 101 🇺🇦 Technical Writing 101 🇺🇦 @technical_writing · 1.45K subscribers
Post #597 2.07K
Выходим из недельного застоя:

1. Статья о шести характеристиках хорошей докментации. Тут без откровений. Характеристик хорошей документации куда больше, но помнить об основе — надо

🔗Читать: Six characteristics of good docs

2. Если вы любитель «second brain» приложений а-ля Notion, есть большая вероятность, что вы уже открыли для себя Obsidian, про который я когда-то уже пару раз писал. Из подписчиков точно кто-то пользовался в компании. Так вот, для него вышел плашин с лучшим линтером простого, челвоеческого английского — Vale. Есть поддержка как и платной серверной версии, так и бесплатной CLI.

🔗 Читать: New plugin: Obsidian Vale

3. Из личного опыта. Писал тут когда-то про Mark — утилиту для синхронизации .md файлов с Clonfluence, которую можно запрячь в CI и вот это вот всё. Пост вызвал относительно бурную дискуссию и в том числе упрёки, что ничего там не работает. Добрался я таки до этой тулзы сам и имею сказать, что все работает. Пользоваться рекомендую Докер-образом и в качестве пароля передавать API-токен. Работает даже на Маке.

#ide #knowledgemanagement #en #testthedocs
  • ❤ 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 →