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?

  • Badland9085@lemm.ee
    link
    fedilink
    arrow-up
    1
    ·
    3 months ago

    I’ve been referencing that Divio doc since 2021, possibly earlier in 2020. I even linked to the document in early 2022. It’s quite likely that it simply wasn’t crawled by the Web Archive before May this year.

    • Kissaki
      link
      fedilink
      English
      arrow-up
      1
      ·
      3 months ago

      Now that you say so, I feel like I’ve read about this before. In comments about Diatraxis/one of them years ago. :)