Skip to content

Commit

Permalink
GITBOOK-855: Update Dev Process cycle, remove ClickUp References, upd…
Browse files Browse the repository at this point in the history
…ate R&Rs info
  • Loading branch information
ARNM1707 authored and gitbook-bot committed Aug 1, 2023
1 parent f425366 commit 3cd7a07
Show file tree
Hide file tree
Showing 15 changed files with 66 additions and 87 deletions.
Binary file added .gitbook/assets/DevProcess (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/DevProcess.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
* [🏗 Research & Development](departments-and-operations/research-and-development/README.md)
* [Release Cycle](departments-operations/research-and-development/release-cycle.md)
* [Product](departments-operations/research-and-development/product/README.md)
* [Roles & Responsibilities](departments-and-operations/research-and-development/product/roles-and-responsibilities.md)
* [Technical Documentation Guidelines](departments-and-operations/research-and-development/product/technical-documentation-guidelines.md)
* [Engineering](departments-operations/research-and-development/engineering/README.md)
* [Engineering Important Definitions](departments-operations/research-and-development/engineering/engineering-important-definitions.md)
Expand All @@ -43,8 +44,8 @@
* [Cloud](departments-operations/research-and-development/engineering/cloud.md)
* [Development](departments-operations/research-and-development/engineering/development/README.md)
* [Migrations](departments-operations/research-and-development/engineering/development/migrations.md)
* [ClickUp Guidelines](departments-operations/research-and-development/engineering/development/clickup-guidelines/README.md)
* [ClickUp Process and Status Changes](departments-operations/research-and-development/engineering/development/clickup-guidelines/clickup-process-and-status-changes.md)
* [General Guidelines](departments-operations/research-and-development/engineering/development/clickup-guidelines/README.md)
* [Development Process](departments-operations/research-and-development/engineering/development/clickup-guidelines/clickup-process-and-status-changes.md)
* [Engineering Work Prioritization](departments-operations/research-and-development/engineering/development/engineering-work-prioritization.md)
* [Development Guidelines](departments-operations/research-and-development/engineering/development/development-guidelines.md)
* [PR General Instructions and Handling](departments-operations/research-and-development/engineering/development/pr-general-instructions-and-handling.md)
Expand All @@ -53,14 +54,14 @@
* [Purpose](departments-operations/research-and-development/engineering/quality-assurance/purpose.md)
* [Industry Standards](departments-operations/research-and-development/engineering/quality-assurance/industry-standards.md)
* [QA Team Roles and Responsibilities](departments-operations/research-and-development/engineering/quality-assurance/qa-team-roles-and-responsibilities/README.md)
* [QA Engineer/Analyst](departments-operations/research-and-development/engineering/quality-assurance/qa-team-roles-and-responsibilities/qa-engineer-analyst.md)
* [QA Engineer](departments-operations/research-and-development/engineering/quality-assurance/qa-team-roles-and-responsibilities/qa-engineer-analyst.md)
* [QA Manager](departments-operations/research-and-development/engineering/quality-assurance/qa-team-roles-and-responsibilities/qa-manager.md)
* [QA Process](departments-operations/research-and-development/engineering/quality-assurance/qa-process/README.md)
* [Software testing](departments-operations/research-and-development/engineering/quality-assurance/qa-process/software-testing.md)
* [QA integration](departments-operations/research-and-development/engineering/quality-assurance/qa-process/qa-integration.md)
* [QA monitoring](departments-operations/research-and-development/engineering/quality-assurance/qa-process/qa-monitoring.md)
* [QA scope](departments-operations/research-and-development/engineering/quality-assurance/qa-process/qa-scope.md)
* [QA Environments](departments-operations/research-and-development/engineering/quality-assurance/qa-process/qa-environments.md)
* [QA environments](departments-operations/research-and-development/engineering/quality-assurance/qa-process/qa-environments.md)
* [QA Bug/Regression Severity](departments-operations/research-and-development/engineering/quality-assurance/qa-process/qa-bug-regression-severity.md)
* [Mobile Testing](departments-operations/research-and-development/engineering/quality-assurance/qa-process/mobile-testing.md)
* [Technology](departments-operations/research-and-development/engineering/quality-assurance/technology/README.md)
Expand All @@ -74,6 +75,7 @@
* [Engineering Manager Onboarding](departments-operations/research-and-development/engineering/engineering-people-management/engineering-onboarding/engineering-manager-onboarding.md)
* [Addressing underperformance](departments-operations/research-and-development/engineering/engineering-people-management/addressing-underperformance.md)
* [Career Planning with Engineers](departments-operations/research-and-development/engineering/engineering-people-management/career-planning-with-engineers.md)
* [PMO](departments-and-operations/research-and-development/pmo.md)
* [🫂 Community](departments-operations/community/README.md)
* [Team](departments-operations/community/team/README.md)
* [Onboarding overview](departments-operations/community/team/onboarding-overview/README.md)
Expand Down
13 changes: 13 additions & 0 deletions departments-and-operations/research-and-development/pmo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# PMO

**Program Management Office** includes aspects of Agile Project Management and GRC - Governance, Risk, Compliance.

* **PMO**
* Process Standardization and Improvements
* Portfolio and Knowledge Management
* Release Planning
* Enterprise Awareness
* **GRC**
* Organize tools and processes to achieve organizational goals reliably, remove uncertainty, mitigate risks, and meet compliance requirements. 
* Conduct risk assessments and internal audits 
* Lead certification processes
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Roles & Responsibilities

## Product Manager

* Define the product vision, strategy and roadmap
* Gather, manage, and prioritize market/customer requirements
* Drive the product and business-planning process across cross-functional teams
* Analyze consumer needs, market trends, and potential partnerships
* Assess current competitors offerings, seeking opportunities for differentiation
* Capture new product ideas from different departments
* Develop, implement and maintain roadmap timelines across multiple departments
* Translate product strategy into detailed requirements for prototype construction and final product development by engineering teams
* Provide continuous support to cross-functional teams by clearly prioritizing work to be done
* Confirm product is delivered in compliance with plans and definitions
* Collaborate closely with engineering, marketing and sales teams on the development, QA, and release of products to ensure success for the entire organization
* Work closely to design team to conduct product discovery 
* Facilitate sprint plannings along with engineers
* Coordinate with product marketing press releases and product launch
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
---
description: >-
We use Clickup as our main work-tracking tool. It gives us good visibility on
the things everyone's working on and also to keep track of important
conversations
We use Jira as our main work-tracking tool. It gives us good visibility on the
things everyone's working on and also to keep track of important conversations
---

# ClickUp Guidelines

## Backend
# General Guidelines

Each task will start in `TO DO`. That means no one is actively working on it. You can take any task from this list that's not currently assigned to someone.

As soon as you get something to work on, you should change the task's status to `IN PROGRESS`.

If, during your development, you find something that you cannot workaround or you have an important question, you should update the status to `BLOCKED`.
If, during your development, you find something that you cannot workaround or you have an important question, you should add a label `BLOCKED`.

* When doing this, remember to **leave a comment** with the reason for the block or with the questions you have

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ClickUp Process and Status Changes
# Development Process

The document aims to share details on different statuses on ClickUp and expected activities related to these statuses.
The document aims to share details on Development Process Flow, its different statuses and expected activities related to them.

## Flow of Work:

Below you find the flow of work starting on “To Do” and ending on “Complete”.
Below you find the flow of work starting on “To Do” and ending on “Done”.

Please note it's not mandatory for an item to go through all this status, but it’s expected for items to move from left to right on the flow to keep communication and alignment with sprint goals.

![](<../../../../../.gitbook/assets/Flow Proposal\_v7.jpg>)
![](<../../../../../.gitbook/assets/DevProcess (1).png>)

## Description of Status and Flows

Expand All @@ -22,7 +22,7 @@ Please note it's not mandatory for an item to go through all this status, but it

If needed, a new backlog item can be created to split the existing item into multiple streams of work/features that better contemplate the needed effort to have the item completed.

### Ready
### Ready for Dev

**Ready** status means an item has received all needed specifications and is waiting for prioritization and assignment to a developer during a sprint.

Expand Down Expand Up @@ -52,22 +52,14 @@ If needed, a new backlog item can be created to split the existing item into mul

Any item placed on this status needs to go back to In progress status before moving to the next stages of this workflow.

### Approved
### QA Tested

**Approved** status means an item followed stream A or B from after **In Review** and matches all acceptance criteria. Item can be merged if applicable as it gets to this status.
**QA Tested** status means an item followed stream A or B from after **In Review,** matches all acceptance criteria and the QA team has confirmed it through tests. Item can be merged if applicable as it gets to this status.

### Done

**Done** status means an item was merged (if needed) and can be deployed during release.

### Complete

**Complete** status means an item was properly documented and is available on a package related to a release on Github.

{% hint style="info" %}
Production-ready on Rocket.Chat is a release bundle available for customers to apply on the self-managed or available to upgrade from SaaS solution – requiring customer action to have any changes effective.
{% endhint %}

### Blocked

**Blocked** status shows an item is blocked and requires blockers of any kind for further actions. Any status except for Complete can go to Blocked and vice-versa. Backlog item assignee is responsible for placing comments related to blocker and sharing with the team what is needed for blockers to be removed.
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,9 @@ During freeze Period:

Focus should still follow the same principle, but now for only Milestone marked tasks. Once all milestone marked tasks are done, and no regressions are left, we resume "regular sprint day work".

&#x20;

**III. Engineering Day:** \
Wider engineering period, lead by chapters where engineers are expected to work on Engineering priorities, PoC, Tech Debt & Documentation; All focused in scaling engineering.

Engineering Day Period:

CTO assigned priorities > Chapter Lead assigned priorities > Tech Lead Priorities > Own initiatives.

Please note this is the most flexible one and you can always reach chapter lead/engineer manager to discuss items and reprioritize the Engineering Day priorities for your squad and yourself.

**IV. Important remarks regardless of period:**&#x20;
**III. Important remarks regardless of period:**&#x20;

1.Remember that tasks assigned to you are your responsibility and require your attention to keep moving ahead on the cycle. The PM/Manager/Lead will help with this up to a certain point and guide which should be the priorities, but this "help" should be minimal from their side.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,9 @@
---
description: >-
Here we may find some key aspects for leadership positions within Engineering
and Product organizations.
description: Here we may find some key aspects for leadership positions within Engineering
---

# Lead Roles & Responsibilities

## Product Manager

* Define the product vision, strategy and roadmap
* Gather, manage, and prioritize market/customer requirements
* Drive the product and business-planning process across cross-functional teams
* Analyze consumer needs, market trends, and potential partnerships
* Assess current competitors offerings, seeking opportunities for differentiation
* Capture new product ideas from different departments
* Develop, implement and maintain roadmap timelines across multiple departments
* Translate product strategy into detailed requirements for prototype construction and final product development by engineering teams
* Provide continuous support to cross-functional teams by clearly prioritizing work to be done
* Confirm product is delivered in compliance with plans and definitions
* Collaborate closely with engineering, marketing and sales teams on the development, QA, and release of products to ensure success for the entire organization
* Work closely to design team to conduct product discovery&#x20;
* Facilitate sprint plannings along with engineers
* Coordinate with product marketing press releases and product launch

## Engineering Manager

Hiring (Squad Formation):&#x20;
Expand Down Expand Up @@ -78,16 +59,3 @@ Team Management:
* Actively seek out impediments to our efficiency as a team ("technical debt"), propose and implement solutions that will enable the entire team to iterate faster&#x20;
* Confidently develop large features and improvements with minimal guidance and support from other team members
* Feed management on how to balance engineering initiatives vs products expectations

## Agilist

* Enables the transition to Agile by empowering teams to develop an Agile mindset&#x20;
* Teach, coach and mentor teams and leadership.
* Set up governing processes to support agile-based approaches.&#x20;
* Define the measurement system by way of identifying relevant metrics.&#x20;
* Facilitate change in new ways of working
* Apply system thinking to expose bottlenecks&#x20;
* Evaluate and advise on agile frameworks&#x20;
* Seek and promote processes improvement&#x20;
* Facilitate cross-squads communication&#x20;
* Support Engineering and Product Management to keep alignment on plans and deliveries
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ description: Definitions on severity identified by QA.

# QA Bug/Regression Severity

CRITICAL - A defect capable of triggering a complete system shutdown, making it impossible to continue using the App. E.g.: Installation failing or a user not able to sign/log in.
**CRITICAL** - A defect capable of triggering a complete system shutdown, making it impossible to continue using the App. E.g.: Installation failing or a user not able to sign/log in.

MAJOR - A defect capable of collapsing a specific business-critical software functionality, but other parts are still functional, so the App is still usable. E.g.: The creation of new Rooms does not work.
**MAJOR** - A defect capable of collapsing a specific business-critical software functionality, but other parts are still functional, so the App is still usable. E.g.: The creation of new Rooms does not work.

MINOR - This issue causes confusion and undesirable behavior, but not enough to affect user experience significantly. Many UI bugs are “minor” issues. E.g.: Avatar sizes being different throughout the app.
**MINOR** - This issue causes confusion and undesirable behavior, but not enough to affect user experience significantly. Many UI bugs are “minor” issues. E.g.: Avatar sizes being different throughout the app.

TRIVIAL - An issue that does not affect functionality or isn’t noticeable. E.g.: Grammar or spelling mistakes, alignment errors, and problems with third-party apps.
**TRIVIAL** - An issue that does not affect functionality or isn’t noticeable. E.g.: Grammar or spelling mistakes, alignment errors, and problems with third-party apps.
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# QA Environments
# QA environments

## I- Objective: <a href="#docs-internal-guid-11f18f18-7fff-cefb-fe31-612e52d63854" id="docs-internal-guid-11f18f18-7fff-cefb-fe31-612e52d63854"></a>

The purpose of this document is to share general information on QA environments available.

## II- Our environments:

A- Individual pull request (PR) QA environment: Environment built on cloud for each PR analysis. We can create an environment for every feature we are working on, thereby giving us a more flexible, isolated development environment, and allowing us to test our code early in the development process.This environment is dismounted after test completion.
**A- Individual pull request (PR) QA environment**: Environment built on cloud for each PR analysis. We can create an environment for every feature we are working on, thereby giving us a more flexible, isolated development environment, and allowing us to test our code early in the development process.This environment is dismounted after test completion.

In order to create an individual PR QA environment, we need to run a command “qa-deploy PR number” in the qa-environment channel on server (open.rocket.chat). Once requested for a QA environment, confirm the PR and finally check status. A link to access the QA environment is displayed which can be accessed using any browser.

B- Unstable environment: Environment containing develop branch and used for general verifications. It is updated automatically every time a PR is merged into develop.
**B- Unstable environment**: Environment containing develop branch and used for general verifications. It is updated automatically every time a PR is merged into develop.

C- Candidate environment: Environment containing all PRs from release candidate that are expected to be deployed on monthly release. It is updated every time there is a new release candidate for the team to perform the various analyzes and tests.
**C- Candidate environment**: Environment containing all PRs from release candidate that are expected to be deployed on monthly release. It is updated every time there is a new release candidate for the team to perform the various analyzes and tests.

D- Stable environment: Environment containing master branch with PRs from previous release and patch release. Only used if a special testing event is needed. Environment is updated every release.
**D- Stable environment**: Environment containing master branch with PRs from previous release and patch release. Only used if a special testing event is needed. Environment is updated every release.

PS: Please note all environments are expected to have Rocket.Chat Enterprise License enabled.
Loading

0 comments on commit 3cd7a07

Please sign in to comment.