DEV Community

# documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
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

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

How to write a kickass README

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

What API documentation generator/tool do you use?

82
Comments 39
2 min read
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 ✅

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

Cognitive Bias and Software Engineering

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

How the ZingSoft Team Uses Notion for Shared Knowledge Management

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

Nail the Fundamentals : Documenting Using Yardoc (YARD)

13
Comments 2
5 min read
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

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
TIL

TIL

6
Comments
1 min read
A Choice

A Choice

6
Comments 1
1 min read
Document your Javascript code with JSDoc

Document your Javascript code with JSDoc

264
Comments 29
5 min read
Keeping OSS documentation with Docsify, Lefthook, and friends

Keeping OSS documentation with Docsify, Lefthook, and friends

56
Comments 2
9 min read
Documentation Sucks and You Probably Do it Too Much

Documentation Sucks and You Probably Do it Too Much

7
Comments 1
3 min read
paperie - looking for beta testers

paperie - looking for beta testers

8
Comments 1
2 min read
On Docs, DX, and Developer Happiness

On Docs, DX, and Developer Happiness

11
Comments
7 min read
Gem markdown_helper Adds Feature: Run Irb

Gem markdown_helper Adds Feature: Run Irb

6
Comments
1 min read
Great Doc Marty! Improve your documentation with the JSDoc api

Great Doc Marty! Improve your documentation with the JSDoc api

10
Comments
3 min read
Building Simple, Yet Powerful Product Integration Documentation

Building Simple, Yet Powerful Product Integration Documentation

8
Comments
3 min read
0-50,000: How my team wrote 50k words of Documentation in under 5months

0-50,000: How my team wrote 50k words of Documentation in under 5months

61
Comments 1
7 min read
Self-documenting is a myth, and how to make your code self-documenting

Self-documenting is a myth, and how to make your code self-documenting

13
Comments 6
6 min read
How I Tricked My Team Into Writing More Documentation

How I Tricked My Team Into Writing More Documentation

164
Comments 6
5 min read
Learning to code by creating open source documentation: a beneficial synergy

Learning to code by creating open source documentation: a beneficial synergy

9
Comments
9 min read
Why do developers hate to write documentations? If not how do you document your code?

Why do developers hate to write documentations? If not how do you document your code?

5
Comments 2
1 min read
How do I prepare for a new dev joining my engineering team?

How do I prepare for a new dev joining my engineering team?

8
Comments
1 min read
What's wrong with godoc?

What's wrong with godoc?

8
Comments
7 min read
Documentation Overhaul - Our Startups Sprint

Documentation Overhaul - Our Startups Sprint

5
Comments
1 min read
Following Cooking Recipes Makes You a Clearer Writer

Following Cooking Recipes Makes You a Clearer Writer

29
Comments 6
6 min read
Is my code self-documenting?

Is my code self-documenting?

7
Comments
1 min read
Name, Please?

Name, Please?

4
Comments 1
1 min read
My Documentation Reading Process

My Documentation Reading Process

14
Comments
4 min read
Translating Vue: Why internationalizing documentation actually matters?

Translating Vue: Why internationalizing documentation actually matters?

10
Comments
3 min read
Maintaining centralized documentation using Docusaurus

Maintaining centralized documentation using Docusaurus

9
Comments
1 min read
Using irb (Interactive Ruby Shell) for Examples

Using irb (Interactive Ruby Shell) for Examples

7
Comments 1
2 min read
How do you document code?

How do you document code?

4
Comments 6
1 min read
Better Front-End Comments

Better Front-End Comments

16
Comments 16
6 min read
Start a project by the README

Start a project by the README

7
Comments
3 min read
The Easiest Way to Keep Product Documentation Up to Date

The Easiest Way to Keep Product Documentation Up to Date

13
Comments 2
3 min read
Why you should document your code.

Why you should document your code.

10
Comments 2
5 min read
Creating CMS Editor Guides

Creating CMS Editor Guides

4
Comments
3 min read
Fun With forEach

Fun With forEach

20
Comments 2
4 min read
tflookup - Developer Diary Part 1

tflookup - Developer Diary Part 1

5
Comments
1 min read
tflookup - Developer Diary Part 2

tflookup - Developer Diary Part 2

2
Comments
2 min read
Trying out Try .NET

Trying out Try .NET

28
Comments 1
7 min read
AngularJS, IE11, and the Importance of Research

AngularJS, IE11, and the Importance of Research

4
Comments 1
2 min read
Why You Should Get to Know Tech Writers

Why You Should Get to Know Tech Writers

9
Comments 1
4 min read
Programming Languages Quick Reference

Programming Languages Quick Reference

6
Comments
1 min read
loading...