Skip to content

Patterns ‐ basic structure for restructing

LiyaMath edited this page Feb 6, 2025 · 4 revisions

In the Patterns Project v1, we have a catalog of best practices categorized into three areas: AI, Cloud, and Web. Organizations such as Aveva and Mastercard have adopted and customized this catalog for their internal use.

Adoption stories can be found at: https://github.com/Green-Software-Foundation/patterns/wiki/Adoption-Stories

Problem Statements

Adoption Challenges for External Organizations:

When external organizations attempt to adopt the patterns, they encounter a significant amount of work. For instance, when Aveva utilized the patterns, they had to develop a scoring method to make them usable internally. We aim to provide this capability built-in to reduce the adaptation effort.

Difficulty in Finding Relevant Patterns:

The current grouping of patterns into three categories (AI, Cloud, and Web) makes it challenging for end users to find relevant patterns for their specific needs.

Technical Complexity:

The existing pattern catalog is highly technical, making it difficult for non-technical stakeholders to use effectively. Goals for v2

Reduce Adaptation Effort:

Minimize the need for organizations to make extensive modifications to the patterns for internal use. This includes providing built-in capabilities such as scoring methods to streamline the adoption process.

Persona-Based Navigation:

Implement persona-based navigation to allow users to explore the catalog according to their career paths. Additionally, enable filtering by various criteria such as project styles (new project, enhancement to an existing project, extending) and project categories (AI, Web, Cloud, etc.).

Expand and Adapt Patterns:

Incorporate more patterns from external sources (e.g., Google Green Guides) and ensure they are measurable by linking them back to the Software Carbon Intensity (SCI) framework.

Scoring System:

Provide a built-in scoring system to evaluate patterns based on their adaptability and impact. This will help organizations prioritize and select the most relevant patterns for their needs.

Behaviour based patterns:

Add behaviour based patterns if feasible and linkable to SCI.

References

  • Patterns catalogue research
  • Google green guides
  • By addressing these problem statements and achieving the outlined goals, we aim to make the pattern catalog more accessible, user-friendly, and adaptable for a wider range of organizations and stakeholders.

Who Can Help?

UX Designers:

**Role: **Identify user journeys to maximize the utility of the pattern catalog and structure the UI accordingly. Reference: New user journey Skills Needed: UI designing experience or willingness to learn. Responsibilities: Conduct user research to understand the needs and pain points of different personas. Design intuitive navigation and filtering options based on user roles and project types. Create wireframes and prototypes to visualize the user interface. **Outcome: **A user-friendly interface that allows easy access to relevant patterns. UI Developers: Role: Enhance the current development platform (Docusaurus) or migrate to a different platform if necessary. Develop new features to improve user experience. Skills Needed: UI development experience or willingness to learn. Responsibilities: Implement the UI designs using Docusaurus or another suitable platform. Develop new features such as advanced search, filtering, and scoring systems. Ensure the platform is accessible. Outcome: A robust and feature-rich platform that enhances user experience. Content Writers with SCI Knowledge: **Role: **Map external patterns to the Software Carbon Intensity (SCI) framework, update existing documentation, and create new patterns based on external guides. **Skills Needed: **Knowledge of SCI and technical writing or willingness to learn. Responsibilities: Research and map external patterns to the SCI framework. Update existing documentation to reflect the latest best practices. Create new patterns based on external guides like the Google Green Guides. Outcome: Comprehensive and up-to-date documentation that aligns with SCI. Subject Matter Experts: **Role: **Review the relevance, importance, and validity of the patterns to ensure they meet industry standards and organizational needs. Skills Needed: Experience in their domains and core green software knowledge.

Responsibilities:

Review patterns for technical accuracy and relevance. Provide feedback on the importance and applicability of patterns. Ensure patterns meet industry standards and organizational needs. Outcome: High-quality patterns that are relevant and valuable to users. Initial Reviewers: **Role: **Perform syntactic and semantic corrections to ensure the clarity and accuracy of the content. Skills Needed: Willing to dedicate time and effort. Responsibilities: Perform initial reviews for grammatical and syntactic accuracy. Ensure the content is clear, concise, and free of errors. Provide feedback for semantic improvements. Outcome: Well-written and error-free documentation.

Parallel Streams

**Stage1: ** |UX Consort (UX Group) | Individual pattern structure revamp(UI designers) | Graduation of patterns | **Stage2: ** |Update current patterns to new structure| Add new patterns| **Stage3(bonus): **| Add automation for initial review|

Open questions

  • Do we need to move to a new development platform.
  • What is the platform for Patterns UX consort -Miro/UXtweak?
  • Are any design tools available like figma?
Clone this wiki locally