"Today, we're launching the Code Wiki website in public preview, our first product built on this new system. It ingests public repositories and generates, hosts, and maintains comprehensive and interactive documentation for each one.Instead of reading static text, you can navigate interactively, jumping directly from high-level concept explanations to the exact code files, classes, and functions they reference. If you get stuck on a complex module, you can ask the Gemini-powered chat agent that uses the always-up-to-date wiki as context to answer highly specific questions about your repository, instantly bridging the gap between learning about the code and actually exploring it. For times when text isn't enough, Code Wiki automatically generates always-current architecture, class, and sequence diagrams, ensuring you can visualize complex relationships that match the exact current state of the code."developers.googleblog.com/en/i#Programming #OpenSource #SoftwareDevelopment #SoftwareDocumentation

all 3 comments

sorted by: hot top controversial new old
[–] [S] 1 point 11 months ago (2 children)

There is no pedagogical intent behind these tools. In this sense, they are a clear example of why LLMs do not understand the meaning of words, merely regurgitating terms that, in the absence of context, make no sense.The upside is that, in the case of many repositories, they can serve as a great example of what bad documentation looks like:"What makes me furious with the heat of a thousand Suns is the fact that some devs could be lured into thinking that this sort of ersatz manuals can check the docs box at all. That some could find these self-inflicted wikis a valid replacement of human-made docs shows the same kind of ignorance (or cynicism) about technical writing that folks display when praising art made by AI.Docs are a product. They require sustained and intelligent effort over a long period of time, as well as a strong community ready to contribute. Docs are the mirror and lore of your code and design, instruments that help you think about what you are architecting and developing. Docs serve purposes and needs. Great docs explain, guide, help, and illustrate. They’re deeply flawed and human. They must be.These wikis, on the other hand, are cargo cult documentation as a service. Their structure could be described as randomly assembling brutalist housing blocks from piles of bricks, their nav a barely plausible FrankenBar that always feels the same. Of course docs must have diagrams, they say, we’re not dummies.While it’s very positive that developers see the lack of docs as an issue, these wikis are not a solution." passo.uno/ai-wikis-docs-teathe

  • source
  • hideshow 2 child comments
  • [–] [S] 1 point 11 months ago

    "This is a case where some docs aren’t better than none, because they signify the triumph of intellectual laziness over trust and accountability. While I’m not concerned about their impact (any enterprise customer would shred you to pieces if you provided docs like those), I think that they represent a trend that we must fight, because docs entirely written by AI are wrong.Let’s draw the line: docs generated entirely by AI should never ship to users. You can use AI judiciously to audit your docs for gaps, to spot inconsistencies, to generate first drafts that you’ll edit later. But the moment you let any LLM have the final word on what users will read, you’ve abandoned the basic contract of docs: that someone who understands the system has taken responsibility for explaining it truthfully."passo.uno/ai-wikis-docs-teathe

  • source
  • parent