Thanks to one of our users from Washington State’s Administrative Office of the Courts for pointing this out: it turned out that the count of “remaining” cards in the Board Summary was including items that were in the Trash, which was misleading.
This has now been fixed: the count shown in the Board Summary gives you a better idea of what work remains.
To access the Board Summary on any Task Board or Scrum Board, click on the Board Summary button shown on the top-right of the Kerika app:
Board Settings is highlighted
Clicking on this button will show a summary of the board, like in this example:
Remaining work
In the example above, the count of “28 items remain” now properly excludes any items that are in the board’s Trash.
Interested in using Kerika for software development? Here’s a practical example, taken from one of our own boards, that highlights best practices for tracking, investigating and fixing bugs.
First, a look at our Workflow
Every software development team will want to set up its own workflow, of course, reflecting its internal dynamics and available resources. Here’s the Scrum Board workflow we use in our team:
Scrum Workflow
Our Scrum Boards are organized with these columns:
The Backlog contains all the ideas, large and small, that we have on our product road map: in Scrum terminology, it’s our Product Backlog.
The Sprint Backlog is the set of cards that we pulled from the Backlog at the start of this Sprint: right now, only 4 items are left as we are close to the end of our 2-week Sprint Cycle.
Within each Sprint, cards are picked up developers and first moved into the Planning column, where detailed analysis of the work to be done is completed.
Depending upon the complexity of a particular work item, a developer may request a design review before moving the card further into the Development column.
Developers do their own unit testing as part of the Development phase, but then the work item moves further down to the the QA column which frequently includes formal code review. (More on that below…)
After a bug has been fixed, had its code reviewed and passed unit testing, it gets Deployed to the Testenvironment.
We usually wait until the 2-week Sprint is over before asking the entire team to present the entire Sprint’s output to the Product Owner for the Show & Tell; this avoids distracting the team midway through the Sprint.
Once the output of a Sprint has passed the Show & Tell, it can then be Deployed toProduction.
The Done column shows all the work that got done in this Sprint. That’s where all cards are supposed to go, but sometimes a work item is abandoned and moved to the Trash.
(Side note: we sometimes use WIP Limits to make sure that people are not over-committed to work, but this is not a consistent practice within our team.)
Logging the bug
Now, let’s take a look at an example of an actual bug card that was worked on by our team:
Example of a bug tracked as a Kerika card
(This particular bug doesn’t have a lot in the details, because it is related to another task that is currently underway, and Kerika makes it easy to link cards, canvases or boards.)
Some bugs go into the Product Backlog, if they are not considered especially urgent, but others go straight into the Sprint Backlog if they represent serious production problems that might affect user’s access or the reliability of their data.
Adding bugs to the Product Backlog lets us process bugs along with other development, e.g. of new features, in the same way: everything can be prioritized by the Product Owner and handled through a consistent workflow.
Documenting the bug
Our bug reports typically come with two attachments; at least one of these should always be included so that the developer has a clear starting point for her work:
A screenshot showing the user experience (if the bug can be observed directly by the user.)
An excerpt from the error log, if the server reported any errors around the time the bug was observed.
Original bug report documents
Kerika makes it easy to attach any kind of content to any card, canvas or board: for bug fixing, particularly in the analysis phase, this is very useful if the user needs to include URLs, material from Sourceforge or similar sites, links to Github, etc.
Repro, Cause & Fix
Before any bug is fixed, our developers always add a standard document we call Repro, Cause and Fix as an attachment to the card:
Repro, Cause and Fix
This document is added no matter how trivial the bug.
Why? Because, on average our team goes through about 30-40 cards a week, and has been doing so for years now. If we don’t document our analysis now, we will never recall our logic in the future.
Repro, Cause and Fix
Our team adopts a consistent layout of the Repro, Cause & Fix document, which we adhere to even for trivial bugs:
The Repro Steps are the steps needed to trigger the bug: usually they consist of a specific sequence of actions taken by a user that cause the bug to appear, but they can also consist of a sequence of events in the background, like specific server activity or memory/CPU utilization conditions, or overall network traffic, that trigger the bug.
The Expected Behavior helps clarify the developer’s understanding of the how the software should behave in this situation. It’s not uncommon for a developer who is new to the team to misunderstand how a particular feature is expected to behave, which could lead to more bugs being introduced. Clarifying Expected Behavior in this document provides an easy way for the Product Owner and the Team Lead to confirm that the developer is not going to go down the wrong track.
Introduced Since: our developers try to pinpoint the specific point in the software’s life where the bug was introduced. This helps the developers reflect upon how errors are created in the first place: the blind spots lie in their analytical patterns that need to be strengthened.
(In this particular example, the developer has been able to point back to some of her own work on an earlier feature implementation that caused this bug to appear.)
Root Cause is not the same as the Repro Steps. While a specific sequence of actions or events may reliably display the effects of a particular bug, they only provide the starting point for the analysis; the Root Cause itself is discovered only when the developer examines the code in detail and determines exactly what is breaking.
Affected Feature: all of our code goes through code review, which we view as one of the most effective QA processes we could adopt, but it can be very challenging when you are processing 30 cards each week, each affecting a different part of the software.
Identifying the Affected Feature helps with the code review process, since the reviewer can consider the bug fix in the larger context of the feature that’s being modified. Without this, it is doubtful that we could review so many changes each week.
Affected User: in most cases, this is “everyone” we offer the same Kerika to all our users, whether they are on free trials or have paid for professional subscriptions.
Identifying Affected Users is useful, nonetheless, when dealing with bugs that are browser-specific, or service-specific: for example, determining that a particular bug affects only Kerika+Google users, or only Internet Explorer users.
The Fix: OK, this might seem obvious, but this section really refers to identifying the specific modules in the software that will be changed as a result of the bug fix being applied.
Like many others, we use Git for managing our source code — along with Maven for builds — since our server environment is all Java-based.
The Fix
The Fix section usually includes references to Git checkins: this helps with future bug fixes, by making it easy to traceback sources of new bugs — part of the Introduced Since section described above.
We use separate Git branches for each feature that we develop so that we can decide precisely what gets released to production, and what is held back for future work.
This helps with the Show & Tell phase of our workflow, when the developers demonstrate the output of the Sprint to the Product Owner, who has the option to accept or reject specific features (i.e. cards on the Scrum Board).
Code Review
All of our code goes through code review, no matter how trivial the change:
Code review
We really believe that code reviews are one of the most effective QA practices we could adopt: having a second pair of eyes look over code can very considerably reduce the chances of new bugs being introduced.
So…
Kerika is great for distributed software teams: our own team is spread out between Seattle and India (roughly 10,000 miles apart!), and all of our work is done using Kerika for task management, content management and team collaboration.
Of course, an added benefit of “eating our own dogfood” is that we are highly motivated to make sure Kerika is the best tool there is for distributed teams :-)
Did you know that we have made it really easy to download files that you attach to a Kerika card, canvas or board?
Just hover your mouse over an attachment, and you will see these buttons appear on the right:
Downloading attachments
These buttons let you:
Download a file
Rename a file
Delete a file attachment
Couple of other points to note:
Rename a file shows off our integration with Google Drive (for our Kerika+Google users) and with Box’s service (for our Kerika+Box users): renaming the file from inside Kerika will automatically rename it in your Google Drive or Box folder as well.
Deleting a file attachment doesn’t actually delete the file from your Google Drive or Box account: it just means that file is no longer attached to that particular Kerika card, canvas or board.
When you sign up directly with Kerika, we take a look at your email address and try to figure out whether you would be better off with Kerika+Google or Kerika+Box.
This helps ensure that you are going to be able to easily collaborate with other people from your company, who may have signed up already using their Google or Box IDs.
Here’s an example: joe@kerika.com tries to sign up directly, and we suggest automatically that he sign up as a Kerika+Box user since so many of his colleagues already have Kerika+Box accounts:
We found and fixed a problem that a small number of users were experiencing: if you had a lot of boards open at the same time — say around 40 — and you then used the URL of any of these boards in some context, e.g. by including it in a chat message, you could run up into a “502 Bad Gateway” server error.
This really was an unexpected edge case — we had never considered that people might be working on 40 boards at the same time, nor that they would routinely have so many boards open, but it turns out that for professional services firms that use Kerika to manage their different client engagements, this was actually not that unusual…
The underlying problem was obscure: Kerika uses a cookie to keep track of which boards you currently have open.
This helps us restore your session perfectly if you exit Kerika and then return, e.g. by simply closing your browser or actually logging out and logging back in.
In the scenario where a user might have had 40 boards open, the cookie was becoming really, really large (as far as cookies go), and our Web server wasn’t set up to handle such large cookies.
Thanks to one of our users at Washington State’s Employment Security Department, we found and fixed a bug that was causing problems when users tried to add SharePoint URLs as attachments on cards, for Task Boards and Scrum Boards.
The problem turned out to be in some code we have that tries to check whether a user is entering a valid-looking URL. SharePoint’s URLs are somewhat unusual in that they include the “{” and “}” characters, which most other web servers don’t use.
Our old code was treating these characters as invalid, thereby rejecting URLs coming from SharePoint.
We now allow users to sign up for Kerika directly, by using any email address. This version is powered by the Box Platform, which allows us to make good use of Box’s cloud storage technology while presenting a simple user interface for our own users.
Another cool feature from Box that we had integrated, as part of this new service, was to use their browser-based preview functionality — which came to Box as a result of their 2014 purchase of Crocodoc.
We use this preview feature with a simple IFRAME integration, which means we don’t add anything to it ourselves, but one downside of this approach is that if Box removes something from their preview capability, it can disappear from Kerika also.
This happened recently when they took away a button that allowed for a quick download of a file that was being previewed.
We have fixed this by adding our own “Download file” link within the Box Preview:
This gave our users more choices in terms of how they signed up for Kerika, and which cloud service they used to store their project files, but we continued to resist offering a direct sign up mechanism:
We remained convinced that third-party signup and login, using OAuth, would dominate user preferences — under the theory that no one really wanted to remember yet another password for yet another web service.
Our technical architecture also restricted us from offering a direct sign up choice because we had tied together the issues of authentication and file storage: it was how our original integration with Google had been done, and we had simply duplicated that model when we added Kerika+Box.
This changed in 2015, when Box announced the Box Platform as a new service — although originally it was called the “Box Developer Edition” when it was unveiled at the BoxDev conference in April 2015.
Kerika was probably the first task management app to sign up to use the Box Platform; in fact, we were in the very first batch of beta users for the service.
This new integration with Box allowed us to finally offer a direct sign up mechanism for new users:
Signing up directly with Kerika
Now, you can sign up with any email address: it could be a company email, a Yahoo email, a Microsoft Live email… even a Gmail address.
When you sign up directly with Kerika, we use the Box Platform to securely store your project files:
We create an account at Box that’s dedicated to storing your Kerika files.
We do this automatically and behind the scenes: you might never know that your files are actually being stored at Box, rather than on a Kerika-operated server.
While this seamless integration is great from a user experience perspective, it doesn’t mean that we want to hide our Box links: in fact, we would actually like to boast about our use of the Box platform because Box is so well regarded for the robustness, security and privacy of their cloud storage service.
So, now you know where your files are stored when you sign up directly as a Kerika user: inside the Box Platform!
We found a bug that was causing problems for users who wanted to edit/update their board descriptions, using Internet Explorer. We fixed that.
In case you are wondering where the board description is found in the first place, here’s how you can edit it:
Click on the gear icon that appears on the top-right corner of every Task Board, Scrum Board or Whiteboard, and then chose the Settings tab:
Editing board descriptions
By default, the board description field will be empty, naturally, but if you are one of the Board Admins (or the Account Owner), when you move your mouse over the Description field you will see a pencil icon appear (highlighted in red, above), and clicking on that will let you add a board description.
Adding a board description
Board descriptions can be up to 180 characters long, and as you type the system will automatically let you know how many characters are left for you to type. (Yes, Twitter-style.)
Board descriptions are going to be very useful in the future as we make some changes to our user interface and search functions.
