DEV Community

Cover image for How Senior Software Engineers Document Their Project

How Senior Software Engineers Document Their Project

Mangabo Kolawole on October 27, 2024

There’s one task that software engineers hate, yet this small attention to detail is what separates a good software engineer from a bad one: How do...
Collapse
 
johndotowl profile image
JohnDotOwl

Hey Chatgpt...

Collapse
 
prahladyeri profile image
Prahlad Yeri

Hello Gemini..

Collapse
 
fast profile image
fast-d3v

Wow you're using Gemini???

Collapse
 
koladev profile image
Mangabo Kolawole

haha ChatGPT is goated for those tasks

Collapse
 
fast profile image
fast-d3v

Claude >>>

Collapse
 
wadecodez profile image
Wade Zimmerman

👋 You're welcome

Collapse
 
prathmeshjagtap profile image
Prathmesh Jagtap

Now its Github Copilot....

Collapse
 
navneet_verma profile image
Navneet Verma

Really needed this as documentation is something every dev is worried about! can you create a detailed guide on this tho?

Collapse
 
koladev profile image
Mangabo Kolawole

Sure I will do

Collapse
 
rahultawar profile image
Rahul

will it be Mangabo-generated? 😂

Collapse
 
kmaheshbabu profile image
Mahesh Babu K

This helpful article for every dev, thanks.

Collapse
 
jairo-dev-jr profile image
Jairo Junior

Here in my team we adopted use RFC model, in every initiative or new software, to document, all of the fluxes.

Collapse
 
tn_decor profile image
TN_Decor

chat GPT nè

Collapse
 
dhan profile image
Dhanush K

Mistral AI

Collapse
 
aldycool profile image
Aldy J

Whole-heartedly agree with this. Sadly, this is mostly ignored by the majorities. They will only realize that THEY need this when they're older and have to deal with many projects...

Collapse
 
teminian profile image
Robert Teminian

What a clever idea. Impressed. Thanks for sharing your secret weapon. ;)

Collapse
 
asologor profile image
Andrew Sologor

Use sequence diagrams.

Collapse
 
koladev profile image
Mangabo Kolawole

Yup. this is a tool that should be part of the ADR. I've done that before. Very useful.

Collapse
 
katafrakt profile image
Paweł Świątkowski

How would you use sequence diagrams to document something like choice of a database? 🤔

Collapse
 
alioune_tour_fc27105ebe2 profile image
Alioune Touré

Thank you for the article. I didn t know about ADRs.
I will definitely help me getting better.

Collapse
 
samuel_dossantos_3d13069 profile image
Samuel dos Santos

Good article. Thank you for sharing your thoughts.

Collapse
 
philip_a_senger profile image
Philip Senger

Well done. I have a Obsidian Template directory with an ADR template, notion is great too. 🥰

Collapse
 
kyriosity-at-github profile image
Kyrill D#

Painfully and tailored. Else it's a pulp.

Collapse
 
brian_staples_ profile image
Brian Staples

Thanks!

Collapse
 
claritiv profile image
Claritiv

Nice

Collapse
 
koladev profile image
Mangabo Kolawole

Thanks Claritiv