links.lmorchard.com - #documentation

The 4 types of technical documentation - Nick's Blog and Digital Garden

Sat, 08 Nov 2025 18:14:04 +0000

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.

Tags: #coding #dev #documentation

Kevin Webb: "One of the best examples of LLM developer tooling I've heard is from a team that supports software from the 80s-90s...."

Wed, 02 Jul 2025 04:31:42 +0000

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.

Tags: #ai #computing #documentation #history #llms #software

Literate Development: AI-Enhanced Software Engineering

Mon, 31 Mar 2025 01:47:58 +0000

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.

Tags: #ai #dev #documentation #llm #ml #work

Diagram of MDN vs general web doco approaches

Mon, 05 Aug 2013 18:04:22 +0000

Tags: #docs #documentation #imported:pinboard #mdn #mozilla #publishing

DevDocs

Fri, 12 Jul 2013 13:21:39 +0000

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

Tags: #css #docs #documentation #html #imported:pinboard #jquery #to:twitter #webdev

DevDocs

Fri, 12 Jul 2013 13:21:39 +0000

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

Tags: #css #docs #documentation #html #jquery #to:twitter #webdev

Jekyll • Simple, blog-aware, static sites

Thu, 23 May 2013 19:37:19 +0000

Transform your plain text into static websites and blogs.

Tags: #cms #documentation #git #gluecon #imported:pinboard #markdown

Jekyll • Simple, blog-aware, static sites

Thu, 23 May 2013 19:37:19 +0000

Transform your plain text into static websites and blogs.

Tags: #cms #documentation #git #gluecon #markdown

GitHub Pages

Thu, 23 May 2013 19:37:10 +0000

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.

Tags: #cms #documentation #git #gluecon #imported:pinboard #markdown

GitHub Pages

Thu, 23 May 2013 19:37:10 +0000

Tags: #cms #documentation #git #gluecon #markdown

Documentation/HowTo - OpenStack

Thu, 23 May 2013 04:54:05 +0000

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.

Tags: #documentation #gluecon #imported:pinboard #openstack

Project 64 Hardware

Sun, 28 Feb 2010 18:07:46 +0000

"Documentation for C64 related Hardware and Firmware"

Tags: #c64 #commodore #documentation #hardware #oldschool #retro

Events/live - jQuery JavaScript Library

Thu, 03 Dec 2009 04:17:28 +0000

"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). "

Tags: #documentation #event #eventdelegation #javascript #jquery #live #webdev

Quetzalcoatal: A public service announcement

Sun, 30 Nov 2008 19:06:23 +0000

"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."

Tags: #coding #comments #documentation #mozilla #opensource #programming

Adblock Plus and (a little) more: Generating JavaScript documentation

Wed, 22 Oct 2008 13:57:51 +0000

"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."

Tags: #documentation #javascript #js