New ask Hacker News story: Ask HN: How do you manage the drift between implemented code and documentation
Ask HN: How do you manage the drift between implemented code and documentation
3 by Sheeny96 | 2 comments on Hacker News.
I work at a medium size financial enterprise. Something that's been cropping up a fair bit recently is that the documentation of processes (how a certain payment system works, what checks it goes through, if this then that etc) have been drifting from it's definition in Confluence (I know, the worst documentation system on the internet, but we're not going to move away from it) and the actual implementation of the code/features. Typically, the initial document is detailed and well laid out, but it is as we build on it that it quickly becomes stale. Often, we're relying on one or two particular people with very strong domain knowledge who have been here since the inception of the system to do our checks and balances and work out what we really need to implement. This is a problem I've seen in a number of places, but it's particularly cumbersome here. How have you managed it?
3 by Sheeny96 | 2 comments on Hacker News.
I work at a medium size financial enterprise. Something that's been cropping up a fair bit recently is that the documentation of processes (how a certain payment system works, what checks it goes through, if this then that etc) have been drifting from it's definition in Confluence (I know, the worst documentation system on the internet, but we're not going to move away from it) and the actual implementation of the code/features. Typically, the initial document is detailed and well laid out, but it is as we build on it that it quickly becomes stale. Often, we're relying on one or two particular people with very strong domain knowledge who have been here since the inception of the system to do our checks and balances and work out what we really need to implement. This is a problem I've seen in a number of places, but it's particularly cumbersome here. How have you managed it?
Comments
Post a Comment