hashgraph / hashgraph/guardian
Improving Naming Conventions of the Features in Documentation
- Dominant language
- TypeScript
- Stars
- 146
- Forks
- 186
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 126
Description
### Problem description
To improve the first-time experience for end users and make Guardian more intuitive for non-technical stakeholders, we need to review and refine our documentation, naming conventions, and overall business language.
Today, many concepts, labels, and flows are written from a technologist’s perspective. This creates confusion for business users who interact with Guardian for compliance, operational, or workflow reasons rather than technical implementation.
This effort will focus on understanding what business users care about first, then aligning our terminology, documentation, and UI language to match that expectation—while still keeping things clear and usable for technical users.
### Requirements
- Evaluate current documentation and identify areas that are overly technical or unclear for business users.
- Review naming conventions across UI, APIs, and documentation for consistency and business relevance.
- Map out the “first-time user” journey from a business perspective and highlight pain points.
- Recommend improved terminology and documentation structure that separates business concepts from technical details.
- Provide a draft style guide for naming and terminology (business-facing vs. technical)
### Definition of done
- Audit of current documentation and naming completed.
- Proposed revised naming conventions and documentation structure delivered.
- Clear list of business-first terminology recommendations.
- Updated onboarding/first-time user overview drafted.
- Reviewed and approved by Product and Design.
### Acceptance criteria
DOD to be completed.
Contributor guide
Assessment
This issue has not been assessed yet.