Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
One thing I miss about unit tests: Unit tests as Documentation
Cover image for One thing I miss about unit tests: Unit tests as Documentation

One thing I miss about unit tests: Unit tests as Documentation

12
Comments
3 min read
Software tests as a documentation tool
Cover image for Software tests as a documentation tool

Software tests as a documentation tool

76
Comments 5
4 min read
Why asking why?

Why asking why?

5
Comments
1 min read
Reading Notes #402

Reading Notes #402

8
Comments 2
2 min read
How to remove condescending language from documentation

How to remove condescending language from documentation

397
Comments 44
6 min read
Architecture Decision Records
Cover image for Architecture Decision Records

Architecture Decision Records

17
Comments 2
4 min read
Principles of Developer Focused Design

Principles of Developer Focused Design

13
Comments 2
3 min read
Creating a documentation website for my open-source package Aloia CMS

Creating a documentation website for my open-source package Aloia CMS

4
Comments
3 min read
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

How to write a kickass README

1703
Comments 46
5 min read
What API documentation generator/tool do you use?

What API documentation generator/tool do you use?

82
Comments 40
2 min read
A case for code comments?
Cover image for A case for code comments?

A case for code comments?

32
Comments 4
5 min read
Setting up the alex.js language linter in your project

Setting up the alex.js language linter in your project

33
Comments
5 min read
Hacktoberfest: complete ✅
Cover image for Hacktoberfest: complete ✅

Hacktoberfest: complete ✅

5
Comments 1
1 min read
Make your project README stand out with animated GIFs/SVGs

Make your project README stand out with animated GIFs/SVGs

70
Comments 8
3 min read
How to write good documentation

How to write good documentation

19
Comments
4 min read
Cognitive Bias and Software Engineering
Cover image for Cognitive Bias and Software Engineering

Cognitive Bias and Software Engineering

12
Comments 2
4 min read
Software documentation is part of accessibility
Cover image for Software documentation is part of accessibility

Software documentation is part of accessibility

4
Comments 3
3 min read
How do you documenting your projects?

How do you documenting your projects?

10
Comments 7
1 min read
How the ZingSoft Team Uses Notion for Shared Knowledge Management
Cover image for How the ZingSoft Team Uses Notion for Shared Knowledge Management

How the ZingSoft Team Uses Notion for Shared Knowledge Management

6
Comments 4
4 min read
Nail the Fundamentals : Documenting Using Yardoc (YARD)
Cover image for Nail the Fundamentals : Documenting Using Yardoc (YARD)

Nail the Fundamentals : Documenting Using Yardoc (YARD)

14
Comments 2
5 min read
How to build a documentation culture
Cover image for How to build a documentation culture

How to build a documentation culture

186
Comments 7
5 min read
September 2019 .NET/ASP.NET Documentation Update

September 2019 .NET/ASP.NET Documentation Update

4
Comments
14 min read
Scraping AWS Docs to Generate PowerShell Help in VaporShell
Cover image for Scraping AWS Docs to Generate PowerShell Help in VaporShell

Scraping AWS Docs to Generate PowerShell Help in VaporShell

7
Comments
4 min read
X-Ray in Lamba

X-Ray in Lamba

18
Comments
5 min read
loading...