Articles
Writing about developer products.
I write about DevRel, documentation, technical content, and the work behind making developer products easier to understand.
Reddit Self-Promotion Rules, Read Properly
Read Reddit’s sitewide guidance and a subreddit’s own rules before you post, then decide whether your contribution is permitted, welcome, or better left unsent.
How to Find the Right Subreddit for a Developer Product
Find the subreddits where developers already discuss a problem, assess local rules, and rule out communities where a useful contribution will not fit.
Code Documentation: Comments, Generated Reference, and External Guides
Decide what belongs in code comments, generated reference, and written guides so each reader can find the right kind of answer.
What Makes a Page Extractable by an Answer Engine
Make answers easier to extract without pretending structure, schema, or llms.txt can earn AI citations or rankings.
llms.txt Examples: Four Public Files Audited Against the Proposal
See how four public llms.txt files differ, which parts match the proposal, and why valid syntax cannot prove that an AI system will use them.
API Documentation Template: The Pages Every API Needs
Download an API documentation template that assigns every page a reader job, from the first request through reference, recovery, events, and changes.
AI Crawlers in robots.txt: Training, Citation, and What Each Block Costs
Separate AI training crawlers from citation crawlers, audit robots.txt safely, and understand what each block prevents.
API Documentation Tools: A Workflow Comparison for Small Teams
Choose an API documentation tool by matching its source of truth, review path, and publishing model to your small team's workflow.
API Documentation Examples: What the Best Developer Portals Get Right
Study developer portal examples by tracing the path from credentials to a working request, exact behavior, and recovery.
API Documentation Best Practices: Reference, Guides, and Working Requests
Build API documentation that carries developers from credentials to a successful request, exact reference details, and actionable recovery.
How to Document Multiple Product Versions
Document supported, retired, and historical product versions with stable URLs, version labels, canonicals, redirects, and tested route policies.
What a Documentation Homepage Must Help Users Do
Design a documentation homepage around first actions, returning tasks, recovery paths, and clear routes instead of an equal-weight card wall.
How to Write Task-Based Documentation Headings
Write documentation headings that tell a reader which task, decision, concept, or recovery path a section covers.
Accessibility Testing for Documentation: A Release Checklist
Test developer documentation for release-blocking accessibility failures in structure, code, links, visuals, keyboard use, and rendered output.
Documentation Style Guide Template for Developer Teams
Download a documentation style guide template that records terminology, code evidence, UI references, and who updates each decision.
Internal vs. External Documentation: What Belongs Where
Compare internal and external documentation, decide where each page belongs, and split shared subjects without exposing private operating context.
What Is Technical Documentation, and What Should It Include?
Technical documentation helps a developer decide, start, use, and recover from a product. Choose each page by the task it owns.
Types of Technical Documentation: 8 Essential Types, Plus Agent Instructions
Understand the main types of technical documentation, study useful examples, and build a documentation system for users, teams, and coding agents.
Technical Documentation Best Practices, Tested on Real Developer Docs
Use a tested review card to make documentation tasks, failure states, limits, and ownership clear before readers need support.
Technical Documentation Template: Build Product Docs With a Tested Structure
Download a technical documentation template, learn what each page must prove, and turn its placeholders into trustworthy product docs.