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?

  • GarlicToast@programming.dev
    link
    fedilink
    arrow-up
    7
    arrow-down
    2
    ·
    1 month ago

    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@lemmy.worldOP
      link
      fedilink
      arrow-up
      5
      ·
      1 month ago

      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? 😂