TGViewer
Shut up and write Shut up and write @shut_up_and_write · 641 subscribers
Post #200 831
Swimm

Swimm — программа для создания документации. Позволяет встроить написание документации в процесс разработки. Такой подход называется Continuous Documentation. Например, можно вставить в документацию кусок кода, когда этот код изменится в исходнике, он изменится в документации. Кроме кусков кода можно вставить в документацию имена файлов или переменных, они тоже будут обновляться вместе с исходным кодом. Если какой-то документ стал не актуальным после изменений кода, то программа отметит его.

Есть плагины для VSCode и IntelliJ. При использовании плагина в коде будут видны ссылки на документацию. Документация открывается в IDE, то есть рядом с кодом, без переходов на другие сайты.

Интерфейс и некоторый фичи похожи на Confluence, например то, как код добавляется в документацию.

Сейчас Swimm в бета тестировании. Видео о том, как начать работать.

#тулзы
More from @shut_up_and_write
  1. Feb 4, 2022Как Twilio создают документацию Пересказ доклада Twilio про пределывание их документации.…
  2. Jan 21, 2022Docs for Developers Обзор на книгу Docs for Developers: An Engineer’s Field Guide to Techn…
  3. Jan 14, 2022Про редизайн документации GitLab - 2 GitLab проводит ежегодные опросы пользователей, чтобы…
  4. Jan 7, 20222021 → 2022 Краткое содержание 2021 и тренды на 2022. Что произошло за 2021 год - Gitlab,…
  5. Dec 24, 2021​​Какой длины делать обучающие видео? Компания TechSmith, которая делает Snagit и Camtasia…
  6. Dec 17, 2021The Best Developer Portals of 2021 Объявили победителей премии The Best Developer Portals.…
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 →