# documentation

5 min read

Jake Lundberg

Dec 5 '23

My 3 Rules for Documenting Code

#development #documentation

124

22

6 min read

Simon Brown

Jul 16 '20

A minimal approach to software architecture documentation

#architecture #productivity #agile #documentation

108

1

2 min read

Carlos Cuesta

Mar 12 '22

Writing Architecture Decision Records

#adr #adrs #documentation

107

2 min read

Cristina Ruth

Jan 6 '20

5 Ways Writing Documentation Helps YOU

#career #documentation #productivity #softskills

84

4 min read

Marc Seitz

Jun 26 '23

How to write a perfect README for your GitHub project

#github #documentation #tutorial #beginners

83

15

4 min read

Ari Kalfus

Nov 14 '19

What API documentation generator/tool do you use?

#discuss #documentation

82

39

2 min read

Ridhwana Khan for The DEV Team

Jan 19 '23

Documenting Forem's v1 API

#ruby #documentation #tutorial #opensource

82

11

14 min read

Beatriz Oliveira

Feb 19

Documentação em toda parte

#documentation #performance #career #braziliandevs

81

5

3 min read

Adam Braimah

Feb 19 '21

A Personal Git Repo as a Knowledge Base Wiki

#productivity #writing #markdown #documentation

77

22

4 min read

Mac Siri for The DEV Team

Sep 22 '23

📢 Announcing New Local Dev Setup Options for Contributing to Forem!

#hacktoberfest23 #meta #opensource #documentation

77

3 min read

Laura Grassi

Dec 15 '23

⭐Crafting Effective Documentation

#documentation #management #learning #tutorial

76

14

5 min read

Stefano Magni

Dec 6 '19

Software tests as a documentation tool

#testing #documentation #handover

76

5

4 min read

Erika Heidi

Jan 10 '23

Setting up a Documentation Website for your Software Project with Hugo and Netlify

#documentation #beginners #opensource #hugo

75

7

9 min read

Gabriel Grubba for Meteor Software

Jan 24

Meteor is getting new docs!

#meteor #javascript #documentation #vite

71

2 min read

Bruno Paz

Nov 2 '19

Make your project README stand out with animated GIFs/SVGs

#documentation #github #tools

69

8

3 min read

Michael Tharrington for The DEV Team

May 25 '23

Lesser Known Features of DEV — Embedding Call To Action (CTA) Buttons

#meta #documentation #community #howtodevto

66

9

2 min read

Drew Town

Dec 16 '19

Writing Better Technical Documentation

#programming #documentation #beginners #sysadmin

65

5 min read

Jeremy Friesen for The DEV Team

Mar 31 '22

The Three Caches of Forem

#todayilearned #documentation #programming #rails

63

4 min read

Lucis

Jun 21 '20

Tech Writing Cheat Sheet

#writing #documentation #cheatsheet

63

2 min read

Ujjwal Tyagi

Apr 10 '23

Document or Die: The Importance of Writing Things Down in Tech

#beginners #devjournal #development #documentation

61

18

4 min read

Alex Antra

Aug 12 '19

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

#documentation #tutorial #writing

61

1

7 min read

Martin Belev

Jun 30 '20

What are you using for your documentation?

#discuss #documentation #webdev

60

23

1 min read

Erika Heidi

Dec 15 '22

Documentação técnica para iniciantes, parte 1: criando um bom README para o seu projeto

#ptbr #iniciantes #documentation

60

3

7 min read

Vladimir Dementyev for Evil Martians

Sep 2 '19

Keeping OSS documentation with Docsify, Lefthook, and friends

#tutorial #documentation #docsify #lefthook

56

9 min read

Mohmed Ishak

Oct 11 '21

This Free Tool Lets You Create World Class Documentation for React Components

#react #documentation #docz #software

52

11

4 min read

Nick Taylor

Sep 28 '20

Projects with Great Documentation

#discuss #documentation #opensource #hacktoberfest

51

64

1 min read

Tiago de Noronha

May 4 '19

Not Documented, Not Done

#documentation

50

12

2 min read

Feli (she/her) for Studio M - Song

Apr 6 '21

Readme's - more than only tech instructions

#documentation #git #leadership #productivity

49

3

3 min read

Jeremy Friesen for The DEV Team

Nov 13 '21

On Writing Documentation

#documentation

49

4 min read

Claudio Taverna

May 26 '23

A practical overview on Architecture Decision Records (ADR)

#softwareengineering #webdev #architecture #documentation

48

8 min read

Shailen Naidoo

Feb 18

The best software engineers write instead of code

#discuss #beginners #learning #documentation

47

33

2 min read

Nik Begley

Aug 20 '20

Confluence Is Where Documentation Goes To Die

#documentation #productivity #writing

46

2 min read

Paula Santamaría

Apr 19 '21

Command-Line Interfaces: Structure & Syntax

#terminal #cli #commandline #documentation

46

8 min read

Erika Heidi

Jan 16

Creating an Automated Documentation Pipeline in PHP with Autodocs and GitHub Actions

#tutorial #php #documentation #automation

42

3

9 min read

Thea

May 15 '20

What is a Python docstring?

#python #beginners #documentation #docstring

40

2 min read

Nik Begley for Doctave

Sep 11 '20

5 components of useful documentation

#writing #devops #agile #documentation

39

8 min read

Michael Tharrington for The DEV Team

Apr 6 '22

Lesser Known Features of DEV — Ignoring a Tag via Negative Follow Weights

#meta #documentation #howtodevto

38

23

1 min read

Yuvaraj

Jul 18 '21

Generate documentation for your Angular App in just 5 simple steps

#webdev #angular #documentation

38

1

2 min read

Michael Tharrington for The DEV Team

Jan 4 '23

Lesser Known Features of DEV — Using Comment Templates

#meta #documentation #community #howtodevto

37

8

2 min read

homemmakako

Nov 23 '21

The Sacred Steps to Achieving Good Documentation

#discuss #writing #opensource #documentation

35

5 min read

Frank Meza for Olio Apps

Jan 31 '20

"The Value of Code Documentation"

#documentation

35

5 min read

Rachel Nabors

Jan 30 '20

New getting started with React Native docs!

#gettingstarted #reactnative #react #documentation

34

1 min read

Carolyn Stransky for Meeshkan

Nov 11 '19

Setting up the alex.js language linter in your project

#documentation #opensource #tools #tutorial

33

5 min read

James.Scott

Nov 13 '19

A case for code comments?

#documentation #ux #beginners #codenewbie

32

5 min read

Brian Rinaldi for Stackbit

Apr 7 '20

Building Documentation Sites with the JAMstack

#webdev #jamstack #documentation

31

13 min read

Vadim Smirnov for Refact AI

Sep 18 '23

📝 🚀 Creating our first documentation from scratch using Astro and Refact AI coding assistant

#ai #javascript #astro #documentation

30

6 min read

Gil Goncalves for Hotjar

Jul 28 '21

Why should you write good commits?

#git #documentation

30

4 min read

Amara Graham

Jul 17 '19

Following Cooking Recipes Makes You a Clearer Writer

#devrel #documentation #developerrelations

29