Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Software tests as a documentation tool
Cover image for Software tests as a documentation tool
noriste profile

Software tests as a documentation tool

#testing #documentation #handover
76
Comments 5
4 min read
Reading Notes #402
fboucheros profile

Reading Notes #402

#blazor #cloud #database #documentation
8
Comments 2
2 min read
How to remove condescending language from documentation
carolstran profile

How to remove condescending language from documentation

#tutorial #documentation #opensource #hacktoberfest
397
Comments 44
6 min read
Architecture Decision Records
Cover image for Architecture Decision Records
tsalikispk profile

Architecture Decision Records

#documentation
17
Comments 2
4 min read
Principles of Developer Focused Design
yitzi profile

Principles of Developer Focused Design

#ux #devrel #documentation
13
Comments 2
3 min read
Writing Documentation
jjowensdev profile

Writing Documentation

#writing #documentation
14
Comments 2
3 min read
How to write a kickass README
Cover image for How to write a kickass README
scottydocs profile

How to write a kickass README

#opensource #documentation #github #beginners
1703
Comments 46
5 min read
What API documentation generator/tool do you use?
artis3n profile

What API documentation generator/tool do you use?

#discuss #documentation
82
Comments 40
2 min read
A case for code comments?
Cover image for A case for code comments?
scottydocs profile

A case for code comments?

#documentation #ux #beginners #codenewbie
32
Comments 4
5 min read
Setting up the alex.js language linter in your project
carolstran profile

Setting up the alex.js language linter in your project

#documentation #opensource #tools #tutorial
33
Comments
5 min read
Make your project README stand out with animated GIFs/SVGs
brpaz profile

Make your project README stand out with animated GIFs/SVGs

#documentation #github #tools
70
Comments 8
3 min read
How to write good documentation
roelofjanelsinga profile

How to write good documentation

#documentation #communication #development #programming
19
Comments
4 min read
Cognitive Bias and Software Engineering
Cover image for Cognitive Bias and Software Engineering
gtanyware profile

Cognitive Bias and Software Engineering

#dunningkruger #cognitivebias #knowledge #documentation
12
Comments 2
4 min read
Software documentation is part of accessibility
Cover image for Software documentation is part of accessibility
azaleamollis profile

Software documentation is part of accessibility

#a11y #opensource #technicalwriting #documentation
4
Comments 3
3 min read
How do you documenting your projects?
itachiuchiha profile

How do you documenting your projects?

#discuss #documentation
10
Comments 7
1 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.