Forem

# documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Stop sending README files as API docs — publish a live, versioned docs site with APIKumo

Stop sending README files as API docs — publish a live, versioned docs site with APIKumo

3
Comments
3 min read
Supercharge AWS Diagrams in VSCode with Mermaid and Custom Icons

Supercharge AWS Diagrams in VSCode with Mermaid and Custom Icons

Comments
3 min read
I Built a Minimal Tool to Instantly Share Text Between Devices
Cover image for I Built a Minimal Tool to Instantly Share Text Between Devices

I Built a Minimal Tool to Instantly Share Text Between Devices

2
Comments
1 min read
Studying the Dangerous Responsibly: AI-Assisted Exploit Documentation as Ethical Practice
Cover image for Studying the Dangerous Responsibly: AI-Assisted Exploit Documentation as Ethical Practice

Studying the Dangerous Responsibly: AI-Assisted Exploit Documentation as Ethical Practice

Comments
11 min read
When a Confusing Task Becomes Your Best Systems Analysis Lesson
Cover image for When a Confusing Task Becomes Your Best Systems Analysis Lesson

When a Confusing Task Becomes Your Best Systems Analysis Lesson

1
Comments
2 min read
llms.txt Is Just a Table of Contents. Most AI Tools Stop There.
Cover image for llms.txt Is Just a Table of Contents. Most AI Tools Stop There.

llms.txt Is Just a Table of Contents. Most AI Tools Stop There.

1
Comments
5 min read
Contract intelligence & AI-powered document automation system
Cover image for Contract intelligence & AI-powered document automation system

Contract intelligence & AI-powered document automation system

Comments
3 min read
ADRs as a Team Habit: The Fastest Path to Better Engineering Decisions
Cover image for ADRs as a Team Habit: The Fastest Path to Better Engineering Decisions

ADRs as a Team Habit: The Fastest Path to Better Engineering Decisions

2
Comments
5 min read
Making Your APIs Visible Using Capabilities for GitHub 7 GitBook Discovery and Documentation
Cover image for Making Your APIs Visible Using Capabilities for GitHub 7 GitBook Discovery and Documentation

Making Your APIs Visible Using Capabilities for GitHub 7 GitBook Discovery and Documentation

Comments
6 min read
How to Write a Good GitHub README (With Examples)

How to Write a Good GitHub README (With Examples)

Comments
2 min read
Over-Documentation Is Not Waste for AI Systems
Cover image for Over-Documentation Is Not Waste for AI Systems

Over-Documentation Is Not Waste for AI Systems

1
Comments
6 min read
AI in docs: Documentation dynamic shift most people seem to ignore
Cover image for AI in docs: Documentation dynamic shift most people seem to ignore

AI in docs: Documentation dynamic shift most people seem to ignore

1
Comments 1
3 min read
I Audited 30 Developer Documentation Sites. Here's What the Best Ones Do Differently.
Cover image for I Audited 30 Developer Documentation Sites. Here's What the Best Ones Do Differently.

I Audited 30 Developer Documentation Sites. Here's What the Best Ones Do Differently.

Comments
2 min read
Why File Paths Are Not Enough for AI Knowledge
Cover image for Why File Paths Are Not Enough for AI Knowledge

Why File Paths Are Not Enough for AI Knowledge

Comments
5 min read
Express is the only major framework where FastAPI-style automated API docs still don't exist

Express is the only major framework where FastAPI-style automated API docs still don't exist

2
Comments
1 min read
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.