IDRs as Records of Intent(wrla.ch)
13 points by evakhoury | 1 comments
Blog post on the wlach log arguing that implementation decision records (IDRs) serve as records of intent in software development.
#documentation on Hacker News
30 stories tagged documentation, newest first.
I paid people to try and follow my README(shkspr.mobi)
356 points by edent | 184 comments
Blog post by Terence Eden on shkspr.mobi about paying people to try following a project's README; the capture shows only a bot-verification interstitial.
The Wild West of polyglot docs sites(technicalwriting.dev)
11 points by zdw | 1 comments
Blog post on technicalwriting.dev about the challenges of building docs sites that unify API reference output from multiple languages' documentation generators.
Agents don't need memory, they need documentation(liao.gg)
348 points by kmeh | 211 comments
Blog post arguing that AI agents benefit more from good documentation than from persistent memory systems.
Prompting Claude Opus 5.5(platform.claude.com)
177 points by Michelangelo11 | 191 comments
Anthropic's Claude Platform documentation page giving prompting guidance for Claude Opus 5.5, covering behavioral differences from Opus 5, effort calibration, thinking, and agentic tasks.
The GitHub wiki is an anti-pattern (2022)(michaelheap.com)
151 points by ibobev | 88 comments
A 2022 blog post by Michael Heap arguing that using the GitHub wiki for project documentation is an anti-pattern compared to a docs folder in the repo.
Quarkdown – Markdown with Superpowers(quarkdown.com)
322 points by amai | 122 comments
Landing page for Quarkdown, an extended Markdown tool for producing papers, books, presentations, static sites, and knowledge bases.
Self-updating screenshots(interblah.net)
426 points by bjhess | 70 comments
Blog post on self-updating screenshots that failed to load, showing a Ruby NoMethodError traceback from the Vanilla-rb wiki software instead.
AI assistance when contributing to the Linux kernel(github.com)
484 points by hmokiguess | 361 comments
Linux kernel documentation file giving guidance for AI tools and developers using AI assistance when contributing to the kernel.
We replaced RAG with a virtual filesystem for our AI documentation assistant(mintlify.com)
375 points by denssumesh | 144 comments
Mintlify engineering blog post explaining how they built a virtual filesystem to replace RAG for their AI documentation assistant.
Ghostty – Terminal Emulator(ghostty.org)
809 points by oli5679 | 336 comments
Documentation homepage for Ghostty, a fast, cross-platform terminal emulator using platform-native UI and GPU acceleration.
I love the work of the ArchWiki maintainers(k7r.eu)
856 points by panic | 155 comments
Blog post by Matthias Kirschner for I Love Free Software Day thanking the ArchWiki maintainers and documentation maintainers for their often-unrecognized work.
Creators of Tailwind laid off 75% of their engineering team(github.com)
1349 points by kevlened | 763 comments
A closed GitHub pull request on the tailwindcss.com repo proposing an /llms.txt endpoint serving text-only Tailwind CSS documentation for LLM consumption.
Examples Are the Best Documentation(rakhim.exotext.com)
372 points by Bogdanp | 137 comments
Blog post by Rakhim arguing that concrete examples are the most useful form of technical documentation and are often missing from official docs.
How I, a beginner developer, read the tutorial you, a developer, wrote for me(anniemueller.com)
782 points by wonger_ | 363 comments
A humorous blog post parodying how developer-written tutorials full of jargon read to a non-developer beginner.
AGENTS.md – Open format for guiding coding agents(agents.md)
766 points by ghuntley | 357 comments
Landing page for AGENTS.md, an open format acting as a README for AI coding agents, giving project context and instructions, used by over 20k open-source projects.
Arch shares its wiki strategy with Debian(lwn.net)
318 points by lemper | 110 comments
LWN article on ArchWiki maintainers' DebConf25 talk explaining how Arch manages its wiki, prompting an effort to revamp the Debian wiki.
Docs – Open source alternative to Notion or Outline(github.com)
1778 points by maelito | 434 comments
GitHub repository for Docs, a collaborative note-taking, wiki and documentation platform built with Django and React by La Suite numérique.
FFmpeg by Example(ffmpegbyexample.com)
812 points by piyushsthr | 221 comments
FFmpeg By Example is a community documentation site showcasing example ffmpeg commands with copy and try-online options.
I prefer rST to Markdown(buttondown.email)
320 points by BerislavLopac | 379 comments
Hillel Wayne's Computer Things newsletter post arguing that reStructuredText is preferable to Markdown for writing books and documentation with Sphinx.
Show HN: I am building an open-source Confluence and Notion alternative(github.com)
477 points by Pi9h | 184 comments
GitHub repository for Docmost, an open-source collaborative wiki and documentation tool positioned as an alternative to Confluence and Notion.
My favourite Git commit (2019)(dhwthompson.com)
628 points by karagenit | 359 comments
A 2019 blog post by David Thompson showcasing a detailed GOV.UK Git commit message as an example of how commit messages document a codebase.
Writing documentation for your house(luke.hsiao.dev)
661 points by lwhsiao | 292 comments
Blog post by Luke Hsiao on writing technical documentation for your house using a changelog framework, MkDocs, and Just for local previews.
Don't use Discord as your Q&A forum(kraktoos.com)
415 points by kraktoos | 255 comments
A blog post arguing that Discord is a poor choice for a project's Q&A forum, citing chaotic message flow and terrible search and discoverability.
Discord is not documentation(shkspr.mobi)
487 points by edent | 257 comments
Terence Eden's blog post arguing that open source projects should not use Discord chat as a substitute for proper documentation, citing the Watchy platform.
MdBook – A command line tool to create books with Markdown(rust-lang.github.io)
391 points by swatson741 | 109 comments
Documentation introduction for mdBook, a Rust command line tool that builds navigable books and documentation sites from Markdown files.
About GitHub’s use of your data(docs.github.com)
348 points by fagnerbrack | 243 comments
GitHub Docs page explaining how GitHub uses repository data to connect users to tools, people, and security recommendations, and its privacy and data sharing practices.
Sequence diagrams, the only good thing UML brought to software development(mermaidchart.com)
573 points by knsv | 333 comments
A Mermaid Chart blog post arguing sequence diagrams are UML's most useful contribution and explaining how they model interactions between system parts.
Just Simply – Stop saying how simple things are in our docs(justsimply.dev)
391 points by cbracketdash | 250 comments
JustSimply.dev is an essay urging writers of technical documentation to stop describing things as "simple" or "easy" because it alienates readers who are struggling.
DuckDuckGo removed the ability to filter search results(github.com)
319 points by Buildstarted | 227 comments
A GitHub commit to DuckDuckGo's help pages updating the search syntax page, removing 64 lines of search operator documentation.