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
 
manishtamang profile image
Manish Tamang •

ai studio google powered by gemini >>

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
 
tn_decor profile image
TN_Decor •

chat GPT nè

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
 
kmaheshbabu profile image
Mahesh Babu K •

This helpful article for every dev, thanks.

Collapse
 
jairojr-software-engineer 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
 
dhan profile image
Dhanush K •

Mistral AI

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
 
asologor profile image
Andrew Sologor • • Edited

I didn't say "Use sequence diagrams for everything in your life", haha :) I mostly meant the example shown in the first picture of the article. Even non-technical people can understand them easily.

Collapse
 
creative555_dev profile image
Creative •

Helpful article.
Thank you
👍🏻❤🚀

Collapse
 
terence_adulugba_ea133e57 profile image
Terence Adulugba •

Can I be your mentee?

Collapse
 
isitvritra profile image
Is It Vritra •

Documentation or Writing related Task - Claude
ChatGPT - BrainStorming and Basic Idea
Research and Thinking - Perplexity
Long Long message and text - Misteral AI

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
 
byteshausmeister profile image
Byteshausmeister •

Painfully and tailored. Else it's a pulp.

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
 
samuel_dossantos_3d13069 profile image
Samuel dos Santos •

Good article. Thank you for sharing your thoughts.

Collapse
 
eduardo_castao_fc8efa122 profile image
Eduardo Castaño •

Thanks a lot for your information provided

Collapse
 
brian_staples_ profile image
Brian Staples •

Thanks!

Collapse
 
_08429c2bd9f28c4a2e243 profile image
小鬼 •

Hey I need an iOS certificate, guys please message me

Collapse
 
bahaeddinesaim profile image
Bahaeddine Saim •

interesting

Collapse
 
claritiv profile image
Claritiv •

Nice

Collapse
 
koladev profile image
Mangabo Kolawole •

Thanks Claritiv