I've worked at software companies big and small for about a decade and the one common theme I see is they all can do a better job organizing information about the software they build and maintain.
Things like architecture diagrams (high/low level diagrams, UML diagrams etc.), UI flowcharts, documentation, metrics etc. are all scattered across various tools that all do that one thing very well. E.g. metrics are in Splunk, documents are probably in Confluence/G-Docs etc.
But it's hard to know how they all tie together unless you have it "hardcoded" in your head. E.g. you must know which dashboard in Splunk surfaces the metrics you're looking for, you must also know which document/runbook in Confluence has the relevant information on how to act on those metrics. And more often than not this documented information, if it exists at all, has drifted from reality i.e. the resources they point to don't exist anymore.
Worse yet, the need for this "hardcoded" information is precisely what makes onboarding new hires hard; it's my least favorite part of joining a new team.
At one of my previous employers, we created a "team page" on the internal wiki that aggregated the team members' directory links, listed the services we owned, included some basic documentation and embedded metrics via iFrames. But even that didn't meet our needs fully.
Wondering what this community feels about this problem (is it even a problem?) and if someone's using a tool that solves this for them at some level.
submitted by /u/maniksar
[link] [comments]
from Software Development – methodologies, techniques, and tools. Covering Agile, RUP, Waterfall + more! https://ift.tt/PzNawci