Wed Oct 26 2022
Bug Reports in the Wild | Integration Problem From Quickbooks to Scotiabank
The how part of issue and bug reporting requires context, detail, and reproduction steps. Let's give it a shot...
We all know that it's a pain, we all hate to do it, and a lot of projects end up in a Texas standoff of sorts trying to figure out who's responsible for it. We do our best to manage expectations on a number of topics on our twitter feed, but it's time to do an exploration of the role breakdowns.
Also - @acorndevops - wow great follow really informative cutting edge industry analysis with a twang of fun and silliness...👀
Generally speaking the need emerges when we are building out Content Management System (CMS) applications. Content management systems utilize patterns of database storage and retrieval that make it efficient to build customer interface designs with adjustable/editable contents.
In this version, there are two divergent streams of thinking that tend to interfere with each other: creation of written contents, and populating the applications page templates for reengagement. This ends up falling into the nebulous void of content strategy. To illustrate these distinctions, we can write a couple of simple user stories.
As a vistor to [your web presence] I am looking to get a summary of your organization, understand the personnel behind the organization, and understand how to contact the business.
As you can see, deliberation and planning needs to go into the page writing to solve organizational objectives. The priority of the page contents factoring in the:
end up being a content drafting exercise. Data entry, then, would have several steps:
Depending on the size of the organization, data entry considerations would need to factor the number of personnel bios required for a practical web experience. For example, many investor driven sites need exposition on the board of directors, their credentials, and a brief personalized bio.
With that, planning for publishing in content strategy is one way to tease out whom, within an organization, will be responsible for utilizing the content management system. This invites our next user story.
As an [organization] event moderator, I want to publish company events to bring people to physical locations, or host webinars, to showcase the value propositions of our organization
This is where confusion emerges.
Content Strategists need to look at the user story and tease our critical metadata. In the story above that could be:
Additionally, content strategists help to tease out associations between content to promote CMS interactivity, and inform the information design.
For example (and there may be time-stamp logic governing this for future applicability), our work on the Vancouver Art Gallery connected exhibitions with supporting events. You can see the JIN-ME YOON: ABOUT TIME is connected to these events:
Understanding these role differentiations is how to breed effective partnerships here. The content strategist can help to tease our major data considerations on a per-page basis, while data entry personnel will be responsible for entering in the contents on an on-going-basis.
Ideally, the right foundations for these joint efforts build off of each other. A content strategist can provide a stable foundation for data-entry personnel to be successful in their role. Feedback from the data-entry personnel, website visitors, and organizational subject matter experts can then inform future content strategy initiatives.
It's magic when it works 🪄
The key tenant for success here is planning. A lot can happen between the time a CMS is setup and configured, contents get populated, and the application itself evolves.
The migration process factors in a number of considerations:
Like everything in assembly, be it mental or physical, the rule of thumb is always
Measure twice, cut once.
Unfortunately, we do need to tend to the dry parts. Our starting point for any content migration is done in a content audit.
Sadly, it is exactly what you would expect it to be.
The content audit is an inventory of every single page on your current content management system.
Page by page, by category if you can, we need to understand the guts of what's in the database. There are a number of ways to approach this, from automation, to vendor assembly of the audit, to an organizations in house team producing the audit itself. It becomes a tired cliché in software but - all of this is context dependant.
Once the audit is done...
Remarkable insights can be gained from review. Invovling clients in the review, especially ones who were previously responsible for content administration and data entry, allows for memory prompts about
With a completed content audit we can springboard into all of the good stuff. What wireframes and mockups are in store? Which pages are unique, and what pages are templates? In what order do we want to design, and develop the templates within the content management system? Having structure for this approach is the mitigation system to avoid going all
on the decision log. With a list of contents to keep, and contents to omit we can substantially reduce the overall costs associated with data entry. Furthermore, by having a visual inventory of what is to be migrated between old and new systems, we set ourselves up for the assignment of roles. Do we:
This boils into what I call the Land of Impossible Distinctions. A land where there is much work to be done, the work itself is arduous, and it can take a lot of time and money. As opposed to sleek and sultry visual deliverables, this part of software initiatives is often overlooked...
So where do we go from here?
Do not take this step of a build initiative for granted. Leaving data entry on the back burner until the 11th hour is a sure fire way to set up a future five alarm for yourself and your client with the only outcomes being jadedness and hurt feelings.
Be sure to understand the differences between what is content ideation, content structuring within the confines of a template, and general data entry for contents that already exist somewhere else. Isolating each one of these steps and handling them sequentially can bring one to a more enjoyable destination:
The Land of Satisfactory Task Completion.
In order to navigate oneself to this promised land never hesitate to seek professional council on these matters, namely in the form of a content strategist who is trained in dismantling the blocks of production and getting the results that one wants. Always remember:
🏴☠️ Nobody wants to do data entry 🏴☠️
Pre-training on the "how" is essential in the long term and can generate all kinds of meaningful feedback if channeled correctly. There is always going to be friction with the first iterations of the tasks themselves. For public facing web experiences like content management systems that having strong user interface (UI) guidelines and sound fundamentals in content strategy, getting the plan right and the team organized is exactly how Acorn Interactive Inc. makes web experiences sparkle ✨