Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
draw.io vs Mermaid vs PlantUML: How Engineers Actually Choose Diagramming Tools
Cover image for draw.io vs Mermaid vs PlantUML: How Engineers Actually Choose Diagramming Tools
akari_iku profile

draw.io vs Mermaid vs PlantUML: How Engineers Actually Choose Diagramming Tools

#discuss #diagrams #documentation #ai
7
Comments
7 min read
Meeting Minutes That Don't Suck: A Developer's Guide to AI Documentation
Cover image for Meeting Minutes That Don't Suck: A Developer's Guide to AI Documentation
huizhudev profile

Meeting Minutes That Don't Suck: A Developer's Guide to AI Documentation

#ai #productivity #documentation #promptengineering
1
Comments
7 min read
The Adventures of Blink S4e10: Blink vs the Gilded Rose: The Rose in Review
Cover image for The Adventures of Blink S4e10: Blink vs the Gilded Rose: The Rose in Review
linkbenjamin profile

The Adventures of Blink S4e10: Blink vs the Gilded Rose: The Rose in Review

#softwareengineering #devex #documentation #beginners
1
Comments
1 min read
Generating Application Specific Go Documentation Using Go AST and Antora
Cover image for Generating Application Specific Go Documentation Using Go AST and Antora
frosnerd profile

Generating Application Specific Go Documentation Using Go AST and Antora

#showdev #go #documentation #html
2
Comments
11 min read
I couldn't keep track of project knowledge, so I automated it
Cover image for I couldn't keep track of project knowledge, so I automated it
samitries profile

I couldn't keep track of project knowledge, so I automated it

#showdev #development #documentation #automation
1
Comments
3 min read
Asciidoc over Markdown
Cover image for Asciidoc over Markdown
nfrankel profile

Asciidoc over Markdown

#documentation #markdown #asciidoc #technicalwriting
12
Comments
6 min read
Automating Documentation Maintenance with Prodigy: A Real-World Case Study
entropicdrift profile

Automating Documentation Maintenance with Prodigy: A Real-World Case Study

#prodigy #documentation #automation #ai
1
Comments
7 min read
Personas Are the Missing Link in Your Requirements Docs (and Test Strategy)
Cover image for Personas Are the Missing Link in Your Requirements Docs (and Test Strategy)
copyleftdev profile

Personas Are the Missing Link in Your Requirements Docs (and Test Strategy)

#documentation #software #ai
1
Comments 3
3 min read
The Adventures of Blink S4e9: The Gilded Rose: The DevEx Patch
Cover image for The Adventures of Blink S4e9: The Gilded Rose: The DevEx Patch
linkbenjamin profile

The Adventures of Blink S4e9: The Gilded Rose: The DevEx Patch

#devex #devrel #documentation #softwareengineering
Comments
1 min read
Building a Culture of Documentation Quality in CI/CD
Cover image for Building a Culture of Documentation Quality in CI/CD
_402ccbd6e5cb02871506 profile

Building a Culture of Documentation Quality in CI/CD

#markdown #cicd #documentation #opensource
Comments
5 min read
đŸ§© Automated Documentation using MkDocs and Python
xandecodes profile

đŸ§© Automated Documentation using MkDocs and Python

#python #markdown #documentation #tutorial
1
Comments
4 min read
It's Time to Write Docs for Machines First, Then for Humans.
francesco_marconi_282058b profile

It's Time to Write Docs for Machines First, Then for Humans.

#ai #llm #promptengineering #documentation
1
Comments
3 min read
From Chaos to Clarity: Lessons learnt on the Importance of Documentation
Cover image for From Chaos to Clarity: Lessons learnt on the Importance of Documentation
pratikshya_behera_ profile

From Chaos to Clarity: Lessons learnt on the Importance of Documentation

#webdev #programming #softwaredevelopment #documentation
1
Comments
2 min read
Guide to Converting LaTeX to PDF: Tools, Tips, and Troubleshooting
mycko22 profile

Guide to Converting LaTeX to PDF: Tools, Tips, and Troubleshooting

#latex #academia #documentation #writing
1
Comments
3 min read
Stop Writing API Docs Twice: Introducing @restdocs for Next.js
charlie_1bafbc034dd4d9b0d profile

Stop Writing API Docs Twice: Introducing @restdocs for Next.js

#nextjs #typescript #testing #documentation
Comments
5 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.