Generative AI is set to benefit the documentation and transformation of legacy code and potentially create new documentation in parallel with new builds.
Documentation in Agile: Challenges and Trends in 2023
Agile documentation refers to the creation and maintenance of documentation in an agile software development process. It emphasizes “just enough” documentation that is necessary for the current iteration, preferring documentation that responds to specific needs over extensive upfront documentation. The goal is to provide clear and concise information to support the development team while keeping […]
Turnover, Documentation and Missing Links
When employee turnover spikes, IT in general and DevOps teams in particular need to be prepared. At the time of this writing, the stock market is roiling, and DevOps compensation is bouncing up. This has an impact on turnover because many in DevOps (and nearly all senior positions) have compensation that includes stock—stock that may […]
Documenting: Don’t Build Your Replacement’s Nightmare
Want to reduce headaches tomorrow? Document everything today About once a year I feel the need to remind you that you are creating technical debt. DevOps is good stuff, and most shops got over the “whatever a given project team decides” multiplication of services pretty quickly, but every line of DevOps code you write is […]
Don’t Expect Miracles
Let’s run some fun scenarios to start this one off, shall we? “We’ll decide what language to use at a meeting next month. Until then, get to writing code!” “We might deploy internally, though Azure is a strong option, and we’ve discussed GCP. Now get operations up and running, we’ll tell you when we’ve decided.” […]
APIs: Automation is Great. So is Usability
Many developers are not so great at documentation. Ask anyone who’s been thrown into a large code base. Changes aren’t documented well, tribal knowledge thrives in the code comments, and anyone who says, “I’m confused, what does this chunk of spaghetti code mean?” is often treated with annoyance or even disdain. That is something that […]