#documentation

Tutorials, which are learning-oriented, practical steps. How-to guides, which are task-oriented, practical steps. Technical references, which capture information-oriented, theoretical knowledge. Explanations (or discussions), which capture understanding-oriented, theoretical knowledge.

One of the best examples of LLM developer tooling I've heard is from a team that supports software from the 80s-90s. Their only source of documentation is *video interviews* with retired employees. So they feed them into transcription software and get summarized searchable notes out the other end.

By emphasizing documentation as the primary source of truth, establishing explicit linkages between development artifacts, and employing iterative, human-guided prompting, the whole team can harness the power of LLMs while mitigating their current limitations.

DevDocs is an all-in-one API documentation reader for developers.

DevDocs is an all-in-one API documentation reader for developers.

Transform your plain text into static websites and blogs.

Transform your plain text into static websites and blogs.

GitHub Pages are hosted for free and easily published through our site, the GitHub for Mac app, or from the command line. Manage your site’s content from GitHub using the tools and workflow that you’re familiar with. Learn about publishing with GitHub Pages here.

GitHub Pages are hosted for free and easily published through our site, the GitHub for Mac app, or from the command line. Manage your site’s content from GitHub using the tools and workflow that you’re familiar with. Learn about publishing with GitHub Pages here.

At the core of OpenStack is the community and collaboration that we do - the same rules for the code apply to documentation too. Ideally any code contribution that is merged into the base has documentation to go with it. Anne Gentle is the coordinator for all documentation efforts, both community-based and "official" docs. This page describes the methods we use to create the basis for world-class documentation for OpenStack developers and users.

"Documentation for C64 related Hardware and Firmware"

"When you bind a "live" event it will bind to all current and future elements on the page (using event delegation). For example if you bound a live click to all "li" elements on the page then added another li at a later time - that click event would continue to work for the new element (this is not the case with bind which must be re-bound on all new elements). "

"If your code will be seen by the world at large, one of your first tasks should be to write documentation. Document all functions as soon as you write them (before is also helpful). Provide samples on how to use code as soon as you finish a module (or earlier, if possible). Do not wait until your 5.0 release. Do not wait until your 1.0 release. Do not even wait until your 0.5 release. Do it as you write your code. The sooner, the better."

"After years of neglecting code documentation I finally came around and added JSDoc comments to much of the Adblock Plus core. The next problem now — what tool should I use to extract these comments and generate documentation? Problem is, none of the off-the-shelf tools know JavaScript 1.8."

"the opening gambit for the vast majority of development efforts I have participated in where I have not been amongst the first generation of programmers to work on the project."

"take your XML source (using the format defined in RFC 2629 and its unofficial successor) and see how the results look like in the original ASCII look-and-feel or the new modern HTML rendition of that look-and-feel."