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?

  • 0x0@programming.dev
    1·
    1 year ago

    The Code is my Bible.

    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.

    Yeah seems about right… off the top of my head:

    • self-host a wiki, use it to document stuff
    • write clean code that your future self will have an easy time reading
    • avoid automated documenting tools
    • Windex007@lemmy.world
      1·
      1 year ago

      Writings self documenting code is so important.

      Comments get stale and over time transition from: accurate to outdated, to eventually flat-out lies.

      Go hard in the paint when choosing method or variable names. If it’s hard to give them coherent names, that’s a code smell.