Forem

# documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Technical Documentation That People Actually Read

Technical Documentation That People Actually Read

Comments
2 min read
Your README Is Your Book Cover. Here's the Checklist I Use for 50+ Projects
Cover image for Your README Is Your Book Cover. Here's the Checklist I Use for 50+ Projects

Your README Is Your Book Cover. Here's the Checklist I Use for 50+ Projects

4
Comments
4 min read
AI and my workflow
Cover image for AI and my workflow

AI and my workflow

Comments
4 min read
Why Documentation Fails in Engineering Teams
Cover image for Why Documentation Fails in Engineering Teams

Why Documentation Fails in Engineering Teams

4
Comments 2
4 min read
MEO - a Markdown editor for VS Code with live/source toggle

MEO - a Markdown editor for VS Code with live/source toggle

1
Comments
1 min read
25 Years of Industrial Testing: What I Learned About Documentation

25 Years of Industrial Testing: What I Learned About Documentation

1
Comments
6 min read
MarkdownConverter.pro – An online Markdown ↔ PDF / Word / HTML conversion tool for developers.

MarkdownConverter.pro – An online Markdown ↔ PDF / Word / HTML conversion tool for developers.

1
Comments
2 min read
How to Build *The Rust Programming Language* Book Locally on Linux
Cover image for How to Build *The Rust Programming Language* Book Locally on Linux

How to Build *The Rust Programming Language* Book Locally on Linux

Comments
3 min read
Seeking Feedback on Documentation and Guidelines for Img2Num 🦔

Seeking Feedback on Documentation and Guidelines for Img2Num 🦔

Comments
1 min read
How to Write a Clean, Professional README.md (A Practical Guide for Developers)
Cover image for How to Write a Clean, Professional README.md (A Practical Guide for Developers)

How to Write a Clean, Professional README.md (A Practical Guide for Developers)

Comments
3 min read
Understanding Industrial IoT Protocols for AI Documentation

Understanding Industrial IoT Protocols for AI Documentation

Comments
5 min read
WorkSafeBC style workflows with careful language and clear evidence limits

WorkSafeBC style workflows with careful language and clear evidence limits

Comments
4 min read
Build.rs-ing Documentation with Cuelang
Cover image for Build.rs-ing Documentation with Cuelang

Build.rs-ing Documentation with Cuelang

Comments
3 min read
Automating Developer Documentation: Why I built an AI Readme Generator

Automating Developer Documentation: Why I built an AI Readme Generator

Comments
1 min read
How I Turned Slack Messages Into Documentation

How I Turned Slack Messages Into Documentation

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