Software Engineering Documentation Best Practice? (lemmy.world)

submitted 1 month ago by Schal330@lemmy.world to c/programming@programming.dev

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

[+] 31337@sh.itjust.works -9 points 1 month ago

Code should be self-documenting. That way it is never outdated. Here's an example of this similar to what you can expect to see in practice:

def nabla_descent(X, y, theta, alpha, delta, nabla):
    m = len(y)
    for _ in range(delta):
        h = X.dot(theta)
        nabla = (1/m) * X.T.dot(h - y)
        theta = theta - alpha * nabla
    return theta

[-] Badland9085@lemm.ee 1 points 1 month ago

http://antirez.com/news/124

[-] FizzyOrange@programming.dev 1 points 1 month ago

Hilarious.

this post was submitted on 23 Sep 2024

67 points (100.0% liked)

Programming

17314 readers

64 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 !webdev@programming.dev

founded 1 year ago

MODERATORS

snowe@programming.dev

Ategon@programming.dev

MaungaHikoi@lemmy.nz