Tag: Documentation
ASD-STE100 Simplified Technical English
A controlled language for writing unambiguous technical instructions
docsite moves to a card-based layout and puts GitHub Sponsors in the sidebar
The sidebar no longer tries to list all 77+ docs, the homepage and projects index became searchable card grids, and GitHub Sponsors got promoted from a footer link to a sidebar button. Eight previously-undocumented repos were added.
Learning from Documentation with the Letta Agent SDK
A practical pattern for giving a persistent Letta agent a bounded documentation corpus, validating its citations, and promoting only reviewed findings.
Authoring an llms.txt for AI Agents
The first consumer of my runner-set library — a CDK construct that runs GitHub Actions jobs on Lambda MicroVMs — was another of my own repos, and the migration was done by an AI agent. The Claude session that moved its nine CI jobs onto the runners filed a field report, and reading it back, every failure it hit traced to something the documentation didn't say, not something it said wrong. The docs never said whether a job can run Docker. The agent probed, hit a sudo failure (no_new_privs is se
docsite ships real SEO and 17 new project pages in one pass
A sitemap, favicon, and layout-owned metadata replaced per-page duplication that was advertising the homepage's description to every crawler, alongside 17 new or updated documentation pages.
Documentation and agent-guidance audit across the fleet
Added or corrected AGENTS.md agent guidance in 49 repositories and fixed AT Protocol trademark/naming wording in 10, after a full source audit.
letta-writer
Memory repository for a Letta Code writing and document agent.
devlog
Centralized changelog and development log for croft.click.
Skills Instead of Setup Docs
My now-playing kiosk has a long install document, and it's a long document. Three hundred and ninety-three lines, eight sequential phases, six environment variables that each gate a different optional install path, and a fifty-line section on a particular display whose touch input lives on a separate USB cable from its video. In addition to this, I wrote a Claude Code skills bundle that walks the same install conversationally. The two ship together in the repo right now. The long doc is the fa
Documentation Parity & Performance
Updating Malachite documentation for new service support and optimizing client bundles.
AI Discoverability — AGENTS.md and llms.txt
Adding AGENTS.md and llms.txt files across repositories to improve AI discoverability and documentation.
GreenGale User Guide
Documentation for Humans
KCS and Technical Writing
Thinking Strategically About Documentation
Architecture Decision Records
How to organize and improve your documentation for your favorite repositories
Travis Arnold - Omnidoc, Restyle, JSX UI
Travis Arnold demonstrates OmniDoc's type-checked documentation system and discusses performance optimization in his React-based UI libraries.
50 mensonges...
D’après 50 Lies told to new people about BDSM, par TylerRose (2018)
La Longue Marche (chronologie simplifiée)
Source : Chronologie de l’histoire Leather : introduction par Tony DeBlase et autres
On AWS Shutting Down Open Source Documentation
AWS is archiving its docs-on-GitHub experiment. Why open documentation still works at scale, drawing on lessons from launching docs.microsoft.com.
Just Works For Me
Why "just" and "works for me" are harmful phrases in tech docs and support, illustrated with a Linux-on-the-desktop experiment that went sideways.
Future of Personal Knowledge
Docs As Part Of The Developer Experience For MSAL
How the MSAL team approaches developer-facing documentation - making engineers core contributors, not delegating writing to a separate content org.
Principles Of Horrible API Documentation
A satirical tour of the worst API documentation patterns - manual HTML, no version control, no examples - and why each one wrecks developer experience.
Références
[x089] SM 101 – A Realistic Introduction, par Jay Wiseman (1996, 1998) ISBN 9780963976383
Android Sample Links on developer.android.com
Find the best samples for an Android topic
Building Evergreen Markdown Notes
Build a personal evergreen knowledge base in Markdown using Hugo, the Docsy theme, and a Docker container for portable rendering.
Avoiding legacy systems
Every software will eventually become a nightmare to maintain, unless we actively do something about it.
One Line Python Documentation
Generating Python API documentation from PyPI packages with a single CLI command via adg, an alternative to setting up Sphinx configuration.
Building A Documentation CLI
Building adg, a Python CLI that wraps DocFX, sphinx-docfx-yaml, and type2docfx so a one-liner can generate API docs across Python, .NET, and TypeScript.
Building Java API Docs With DocFX
Generate Java API reference documentation using a custom DocFX doclet that consumes Javadoc output and produces HTML via DocFX templates.
Building Docs With GitHub Actions
Build and publish DocFX-generated documentation using a GitHub Actions workflow, with a containerized step that handles output deployment to the cloud.
On Structured Content
Why YAML-based structured content beats freeform Markdown for API documentation at scale, drawn from work on docs.microsoft.com and DocFX.
Easy Docs For Node And Python
Use doctainers, a set of Dockerized DocFX pipelines, to generate API documentation for Node.js, TypeScript, and Python libraries.
DIY Docs In The Cloud
Generate and host technical documentation in the cloud using DocFX, Docker, and a static-site pipeline you can run on any provider.
Coffee And Docs: Intro To DocFX
A short video walkthrough of DocFX, the open-source documentation generator that powers docs.microsoft.com, covering setup and a first build.
5 Things Learned Generating API Documentation
Five takeaways from a year of generating API documentation at scale, covering author variability, tooling, samples, validation, and review loops.
Summer Of Docs - Documenting .NET Libraries
Generate API reference documentation for .NET libraries with DocFX on macOS, including the ECMA2YAML pipeline used by docs.microsoft.com.
Visual Studio Code And docs.microsoft.com API Docs
Building a cross-platform VS Code extension that performs docs.microsoft.com API documentation lookups, scaffolded with Yeoman and TypeScript.
Building Docs For NuGet Packages With VSTS And GitHub Pages
Wire up a VSTS build pipeline to generate API docs from a NuGet package and publish the output to GitHub Pages on every commit.
Talking Self-Driving Cars, Docs And Community On MSDevShow
Guest appearance on MSDevShow with Jason Young and Carl Schweitzer covering self-driving cars, documentation work, and developer community.
Easy Spec Reviews With GitHub & Bots
Build SpecBot, a GitHub webhook-driven Node.js bot that auto-creates issues for inline review comments on Markdown specification documents.
How We Build Documentation For .NET-Based SDKs
How the docs.microsoft.com team generates .NET API reference from compiled assemblies, handling versioning, multi-framework, and reliability at scale.
On Importance Of Documentation
Reflections after a year working on docs.microsoft.com on why documentation systems matter and how publishing infrastructure shapes product adoption.