Programming

17313 readers

412 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago

MODERATORS

[email protected]

Software Engineering Documentation Best Practice? (self.programming)

submitted 2 months ago by Schal330 to c/[email protected]

34 comments fedilink hide all child comments

Hey all, I'm still a junior dev with years of experience in IT. One of the things I've noticed since making the switch is that (at least where I work) documentation is inconsistent.

Things I encounter include incomplete documentation, outdated documentation and written process details that have assumed knowledge which makes it difficult for junior Devs to pick up.

I've had a search and a lot of what is out there talks more about product and how to document that SDLC rather than best practice in writing and organising documents against the actual software engineering and its processes.

Does anyone have any good sources or suggestions on how I could look to try and begin to improve documentation within my team?

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 5 points 2 months ago (1 children)

Partial documentation combined with complex code will be great for your bank account.

Code fast, and badly, always under promise and over deliver. Before the shit hits the fan, move to another place.

Next person after you will take the blame. You may be hired again at premium as you can deliver. Blame the replacement Dev for breaking the code and causing a lot of damage.

Fix the little that is possible, at premium rate and move on.

[–] Schal330 5 points 2 months ago (2 children)

I'm still in those early cautiously optimistic stage where I hope I can make a positive change that will help those who come after me. How long does it take for the pessimism to set in? 😂

[–] [email protected] 3 points 2 months ago

Don't change. It's much more fun this way

[–] Simplicity 1 points 2 months ago

Be the change you want to see.

And to answer your question, about as long as it takes to have 2 or 3 of people like them as your boss/lead.