From e854687e1f176c21c861a88c295b0bb978acddb8 Mon Sep 17 00:00:00 2001 From: Luke Heath Date: Mon, 29 Jul 2024 12:03:23 -0700 Subject: [PATCH] Add feature guide instructions (#20668) Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com> --- handbook/engineering/README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/handbook/engineering/README.md b/handbook/engineering/README.md index 05e5e74751..f94873d05d 100644 --- a/handbook/engineering/README.md +++ b/handbook/engineering/README.md @@ -10,7 +10,6 @@ This handbook page details processes specific to working [with](#contact-us) and | Quality Assurance Engineer (QA) | _See [🛩️ Product groups](https://fleetdm.com/handbook/company/product-groups#current-product-groups)_ | Software Engineer | _See [🛩️ Product groups](https://fleetdm.com/handbook/company/product-groups#current-product-groups)_ - ## Contact us - To **make a request** of this department, [create an issue](https://fleetdm.com/handbook/company/product-groups#current-product-groups) and a team member will get back to you within one business day (If urgent, mention a [team member](#team) in the [#help-engineering](https://fleetdm.slack.com/archives/C019WG4GH0A) Slack channel. - Any Fleet team member can [view the kanban boards](https://fleetdm.com/handbook/company/product-groups#current-product-groups) for this department, including pending tasks and the status of new requests. @@ -29,6 +28,16 @@ The metrics are: Each week these are tracked and shared in the weekly KPI sheet by Luke Heath. +### Write a feature guide + +We write [guides](https://fleetdm.com/guides) for all new features. Feature guides are published before the feature is released so that our users understand how the feature is intended to work. A guide is a type of article, so the process for writing a guide and article is the same. + +1. Review and follow the [Fleet writing style guide](https://fleetdm.com/handbook/company/communications#writing). +2. Make a copy of the ["Article: Guide Template"](https://docs.google.com/document/d/1OPcDouyfyFPg3ScrN4bo6ol8vMfMa3P9-BIfbnEdcg4/copy) and rename "Article: [Guide] {feature name}". +3. Open the template and insert your content into the provided template format. +4. Create a [new GitHub issue](https://github.com/fleetdm/fleet/issues/new?assignees=spokanemac&labels=:help-it&title=New%20guide:) with the guide title, and add the `:help-it` label. It will be processed and added to the website by our [Community Advocate](https://fleetdm.com/handbook/engineering#team). + + ### Create an engineering-initiated story Engineering-initiated stories are types of user stories created by engineers to make technical changes to Fleet. Technical changes should improve the user experience or contributor experience. For example, optimizing SQL that improves the response time of an API endpoint improves user experience by reducing latency. A script that generates common boilerplate, or automated tests to cover important business logic, improves the quality of life for contributors, making them happier and more productive, resulting in faster delivery of features to our customers.