Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Hacking with mdBook

Hacking with mdBook

1
Comments
5 min read
☁️ What Is Compute in the Cloud? (And Why AWS Gives You So Many Options)

☁️ What Is Compute in the Cloud? (And Why AWS Gives You So Many Options)

Comments 1
3 min read
💎 Ann: shields-badge v1.0.0
Cover image for 💎 Ann: shields-badge v1.0.0

💎 Ann: shields-badge v1.0.0

5
Comments
2 min read
I hate FAQs and they might make AI dumb

I hate FAQs and they might make AI dumb

Comments
1 min read
🧠 What Is Git? (And Why It’s the Time Machine Your Code Needs)

🧠 What Is Git? (And Why It’s the Time Machine Your Code Needs)

1
Comments 1
3 min read
🤝 What Is Git Teamwork? (And Why It Makes Collaboration Smooth Like Butter)

🤝 What Is Git Teamwork? (And Why It Makes Collaboration Smooth Like Butter)

2
Comments 1
3 min read
Don't do this #1

Don't do this #1

Comments 1
1 min read
I Compared Four API Docs. Some Made Me Smile, Some Made Me Sigh
Cover image for I Compared Four API Docs. Some Made Me Smile, Some Made Me Sigh

I Compared Four API Docs. Some Made Me Smile, Some Made Me Sigh

Comments
3 min read
My first Open Source contribution
Cover image for My first Open Source contribution

My first Open Source contribution

3
Comments 1
4 min read
O Papel das APIs no Desenvolvimento Moderno: Entendendo as Engrenagens Invisíveis da Tecnologia
Cover image for O Papel das APIs no Desenvolvimento Moderno: Entendendo as Engrenagens Invisíveis da Tecnologia

O Papel das APIs no Desenvolvimento Moderno: Entendendo as Engrenagens Invisíveis da Tecnologia

Comments
4 min read
🗃️ What Is SQL Manipulation? (And Why It’s Like Talking to a Super-Organized Assistant)

🗃️ What Is SQL Manipulation? (And Why It’s Like Talking to a Super-Organized Assistant)

Comments 1
3 min read
Swagger: Document APIs Like a Pro
Cover image for Swagger: Document APIs Like a Pro

Swagger: Document APIs Like a Pro

1
Comments
8 min read
API Documentation for NestJS

API Documentation for NestJS

Comments
3 min read
Contributing to Elixir Documentation: My Journey with PR #14501
Cover image for Contributing to Elixir Documentation: My Journey with PR #14501

Contributing to Elixir Documentation: My Journey with PR #14501

3
Comments 1
4 min read
Making Sense of Software Architecture with the C4 Model
Cover image for Making Sense of Software Architecture with the C4 Model

Making Sense of Software Architecture with the C4 Model

27
Comments 1
4 min read
🐘 The Elephant and the Chains — A Lesson on Breaking Limits

🐘 The Elephant and the Chains — A Lesson on Breaking Limits

Comments
1 min read
You Asked, I Coded: How I Turned AWS Architecture into a Diagram Using Code
Cover image for You Asked, I Coded: How I Turned AWS Architecture into a Diagram Using Code

You Asked, I Coded: How I Turned AWS Architecture into a Diagram Using Code

6
Comments 1
4 min read
How to Migrate Technical Documentation: Tools, Checklist, and Tips
Cover image for How to Migrate Technical Documentation: Tools, Checklist, and Tips

How to Migrate Technical Documentation: Tools, Checklist, and Tips

2
Comments
8 min read
Documentation Release Notes - March 2025

Documentation Release Notes - March 2025

Comments
10 min read
How to Talk to Engineers About AI: A Beginner’s Guide (Coming Soon)
Cover image for How to Talk to Engineers About AI: A Beginner’s Guide (Coming Soon)

How to Talk to Engineers About AI: A Beginner’s Guide (Coming Soon)

5
Comments
1 min read
Python VEnv Setup: A Rails Developer's Survival Guide 🐍
Cover image for Python VEnv Setup: A Rails Developer's Survival Guide 🐍

Python VEnv Setup: A Rails Developer's Survival Guide 🐍

2
Comments 2
2 min read
🧙‍♂️ What Is Git? (And Why Every Developer Should Learn the Basics)

🧙‍♂️ What Is Git? (And Why Every Developer Should Learn the Basics)

Comments 2
3 min read
Getting started with GraphQL
Cover image for Getting started with GraphQL

Getting started with GraphQL

Comments
5 min read
What is Technical Writing?
Cover image for What is Technical Writing?

What is Technical Writing?

Comments
4 min read
The Art of API Documentation: A Comprehensive Guide

The Art of API Documentation: A Comprehensive Guide

Comments
4 min read
loading...