Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
A practical overview on Architecture Decision Records (ADR)
Cover image for A practical overview on Architecture Decision Records (ADR)
ctaverna profile

A practical overview on Architecture Decision Records (ADR)

#softwareengineering #webdev #architecture #documentation
48
Comments 4
8 min read
Mastering Readme Files
unnotedme profile

Mastering Readme Files

#readme #documentation #project #git
18
Comments
4 min read
Crafting Software Architecture artefacts: Transformer Chronicles
Cover image for Crafting Software Architecture artefacts: Transformer Chronicles
balagmadhu profile

Crafting Software Architecture artefacts: Transformer Chronicles

#architecture #chatgpt #documentation
7
Comments 1
4 min read
How to use Analytics to improve your Technical documentation's performance
Cover image for How to use Analytics to improve your Technical documentation's performance
mikacodez profile

How to use Analytics to improve your Technical documentation's performance

#webdev #documentation #programming #tutorial
Comments
3 min read
Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx
Cover image for Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx
coderatul profile

Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx

#documentation #opensource #python #tutorial
13
Comments
2 min read
How to define Objects with type definitions in JSDoc comments
darkmavis1980 profile

How to define Objects with type definitions in JSDoc comments

#documentation #vscode #javascript #webdev
15
Comments
2 min read
Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs
Cover image for Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs
christophedujarric profile

Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs

#api #documentation #asyncapi #openapi
Comments
4 min read
Converting Jupyter Notebooks to Markdown Made Easy with nbconvert
Cover image for Converting Jupyter Notebooks to Markdown Made Easy with nbconvert
coderatul profile

Converting Jupyter Notebooks to Markdown Made Easy with nbconvert

#python #tutorial #productivity #documentation
17
Comments 2
3 min read
ChatGPT Unplugged: Empowering Developer for documentation
Cover image for ChatGPT Unplugged: Empowering Developer for documentation
balagmadhu profile

ChatGPT Unplugged: Empowering Developer for documentation

#softwareengineering #documentation #chatgpt
5
Comments
6 min read
Async API documentation 101
zsevic profile

Async API documentation 101

#documentation #api #nestjs #node
1
Comments
1 min read
Deployment Notes: How we document changes to production
Cover image for Deployment Notes: How we document changes to production
markandrus profile

Deployment Notes: How we document changes to production

#cicd #documentation #githubactions #deploy
1
Comments
5 min read
Documentação Viva: Uma Nova Abordagem para Documentação de Software
pedropietro profile

Documentação Viva: Uma Nova Abordagem para Documentação de Software

#java #documentation #architecture #braziliandevs
4
Comments
6 min read
O Método de Documentação C4Model e sua aplicação com PUML
pedropietro profile

O Método de Documentação C4Model e sua aplicação com PUML

#documentation #uml #braziliandevs
6
Comments
3 min read
Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free
Cover image for Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free
jeffsalive profile

Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free

#tango #documentation #productivity #team
5
Comments
4 min read
Add comments to your Docusaurus website in 5 minutes
Cover image for Add comments to your Docusaurus website in 5 minutes
anshuman_bhardwaj profile

Add comments to your Docusaurus website in 5 minutes

#documentation #javascript #react
10
Comments 15
3 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.