Why Hashtags Matter in Our Documentation At Flagship LMS, every solution we create should save time and effort for the future. When a problem is solved once, we document the steps clearly so that no one ever has to start from scratch again. This is where hashtags come into play. By using standardized hashtags, we ensure that future developers can quickly and easily find the solutions they need to problems that have already been addressed.
Standardized Hashtags: A Must for Efficiency When you document a problem and its solution, it’s essential to use our standardized hashtag system. These hashtags allow us to categorize and search for problems based on type, component, and severity. For example, is it a backend issue? Frontend? Is it related to a plugin or a theme? All these details can be captured in hashtags, allowing a future developer to drill down and find exactly what they need. This system saves time, reduces duplicate work, and ensures consistency across our team.
However, the key to making this system work is standardization. Each developer must use the same set of hashtags, rather than creating new ones on the fly. This consistency means that every problem and solution can be searched and referenced in the same way, every time. If we each used our own hashtags, finding past solutions would be a nightmare.
When to Add New Hashtags Our hashtag list is not static—it can grow as new types of problems arise. If you encounter an issue that doesn’t fit into the current set of hashtags, you can propose adding a new one. But remember, hashtags are never removed. Older problems rely on them to be searchable, so we can only add to the list, not take away.
This approach ensures that no solution is ever lost, and our documentation remains a valuable resource for everyone.
The Right Way to Document
When writing documentation, make sure to:
- Always start hashtags with the # symbol, followed by lowercase text.
- Use multiple hashtags to fully describe the problem, such as #backend #php #critical or #theme #edumy #solved.
Follow the structure laid out for documentation:
- provide a problem description, steps taken, any relevant screenshots, and links to Basecamp tasks or client information.
By sticking to this system, you’re not just documenting for yourself—you’re helping the entire team and future developers solve problems faster and more effectively.