@istima прислал прекрасную статью про потерянную документацию. Уверен, что тебе понравится.

#docs
http://13lad.livejournal.com/361558.html

Это прекрасно: твиттер тред, в который постят куски из документации, написанные в ascii art.

#twitter #ascii #docs

Коротко, понятно, и есть, над чем подумать: размышления об использовании примеров в тех. документации (что-то типа https://ohshitgit.com/ VS. https://git-scm.com/docs)

#docs

Текстовый пересказ доклада Dan Lew про поддержание корректности. Ничего нового там нет, внутренние знания, документация, проверки и т.п. И тем не менее, мне очень нравится, как оно всё структурировано. Это хорошая работа, я считаю.

#docs #lint #test

Вот это прямо рил ток: примеры (особенно те, которые можно прямо там же редактировать и исполнять) - лучшая документация.
Я дико радуюсь с clojuredocs, которые интегрированы в LSP и прямо там, где ты код пишешь, можешь увидеть разные примеры использования какой-то функции.
И помним про Go: примеры как особый вид тестов, который интерактивно доступен в документации.
После всего этого счастья хочется плакать, когда работаешь с Python. Документация стандартной библиотеки в массе своей - кусок говна. Много текста, ноль понимания. Документация сторонних библиотек - то же самое, по большей части. Есть несколько удачных примеров, но это скорее исключение.

#docs #tool

Google сделали codewiki. Идея простая: возьми коммит из репо (ну, типа, всегда актуальная версия), проанализируй весь код через Gemini, сделай доку, дай поспрашивать LLM сразу со всем контекстом проекта. Мне кажется, идея очень богатая. У меня было бы 2-3 довольно частых юзкейса для этой штуки.
НО: именно с точки зрения доков публичных библиотек, там пока очень мало что проиндексировали. Я проверил либы, по которым мне приходилось копать доку в последнее время - ничего нет, кроме одной супер-крупной. Но "Try it with your own private repository" как бы намекает, что фокус - не только на открытом коде.

#ai #llm #docs