Skip to content

README_EN.md

Latest commit

ย 

History

History
147 lines (107 loc) ยท 5.56 KB

README_EN.md

File metadata and controls

147 lines (107 loc) ยท 5.56 KB
Raw

๐Ÿ“‹ PM Documentation Generator Workflows (Multi-Company Styles)

English | ไธญๆ–‡

Windsurf-based workflows for generating project manager documentation, supporting styles from Tencent, Alibaba, ByteDance, Google, Amazon, Microsoft, and Meta. Generate 10+ standardized project documents including PRD, design docs, risk management, and release plans with one click.

โœจ Features

  • ๐Ÿข Multiple Company Styles: 7 styles total - Chinese (Tencent/Alibaba/ByteDance) + International (Google/Amazon/Microsoft/Meta)
  • ๐Ÿ“„ Complete Document Packages: 10-14 documents per style, covering the entire project lifecycle
  • ๐ŸŽฏ Unique Focus Areas:
    • Tencent: TAPD style, project delivery & process control
    • Alibaba: Aone style, metrics-driven & data closure
    • ByteDance: Experimentation/gradual rollout, data attribution, fast iteration
    • Google: Design Doc, Privacy/Security, Rollout
    • Amazon: PRFAQ (Working Backwards), Operational Readiness
    • Microsoft: Spec-driven, Accessibility, Compliance
    • Meta: RFC, Experiment Plan, Guardrails
  • ๐Ÿ”— Separated Templates: Workflows and templates are separated for easy customization
  • ๐ŸŒ Bilingual: Chinese output for Chinese companies, English output for international companies

๐Ÿ“ Directory Structure

.windsurf/
โ”œโ”€โ”€ workflows/                              # Windsurf workflows
โ”‚   โ”œโ”€โ”€ pm-docs-from-brief-tencent-zh.md    # Tencent style (Chinese)
โ”‚   โ”œโ”€โ”€ pm-docs-from-brief-alibaba-zh.md    # Alibaba style (Chinese)
โ”‚   โ”œโ”€โ”€ pm-docs-from-brief-bytedance-zh.md  # ByteDance style (Chinese)
โ”‚   โ”œโ”€โ”€ pm-docs-from-brief-google-en.md     # Google style (English)
โ”‚   โ”œโ”€โ”€ pm-docs-from-brief-amazon-en.md     # Amazon style (English)
โ”‚   โ”œโ”€โ”€ pm-docs-from-brief-microsoft-en.md  # Microsoft style (English)
โ”‚   โ””โ”€โ”€ pm-docs-from-brief-meta-en.md       # Meta style (English)
โ”‚
โ””โ”€โ”€ templates/                              # Document templates
    โ”œโ”€โ”€ tencent/                            # Tencent templates (14 files)
    โ”œโ”€โ”€ alibaba/                            # Alibaba templates (14 files)
    โ”œโ”€โ”€ bytedance/                          # ByteDance templates (14 files)
    โ”œโ”€โ”€ google/                             # Google templates (12 files)
    โ”œโ”€โ”€ amazon/                             # Amazon templates (13 files)
    โ”œโ”€โ”€ microsoft/                          # Microsoft templates (12 files)
    โ””โ”€โ”€ meta/                               # Meta templates (13 files)

๐Ÿš€ Quick Start

1. Using with Windsurf

  1. Clone this repository locally
  2. Open the project in Windsurf
  3. Use slash commands to invoke workflows, e.g.:
    • /pm-docs-from-brief-tencent-zh - Tencent style
    • /pm-docs-from-brief-alibaba-zh - Alibaba style
    • /pm-docs-from-brief-google-en - Google style
  4. Fill in your project description as prompted
  5. Receive a complete project documentation package

2. Manual Usage

  1. Open the corresponding workflow file (e.g., .windsurf/workflows/pm-docs-from-brief-google-en.md)
  2. Copy the prompt from the "Generation prompt" section
  3. Replace <<<PROJECT_BRIEF>>> with your project information
  4. Paste into any AI assistant (ChatGPT/Claude/Gemini, etc.)
  5. Save the output files to your docs/ directory

๐Ÿ“‘ Output Document List

Chinese Companies (14 documents)

# Filename Description
1 00-project-brief.md Project Overview
2 01-prd.md Product Requirements Document
3 01a-metrics-and-tracking.md Metrics & Tracking Plan
4 02-scope-and-milestones.md Scope & Milestones
5 03-wbs-and-estimation.md WBS & Estimation
6 03a-solution-design.md Solution Design & Tech Review
7 04-raci-and-comms-plan.md RACI & Communication Plan
8 05-risk-issues-dependencies.md Risk/Issue/Dependency Log
9 06-nfr-and-acceptance.md NFR & Acceptance Criteria
10 06a-test-plan.md Test Plan & Quality Gates
11 07-release-rollout-runbook.md Release/Rollout Runbook
12 08-meeting-notes-template.md Meeting Notes Template
13 09-weekly-status-template.md Weekly Status Template
14 10-change-log.md Change Log & Decision Log

International Companies (English)

Each company has 1-2 unique documents:

  • Google: design-doc.md (Design Doc)
  • Amazon: prfaq.md (PRFAQ), operational-readiness.md
  • Microsoft: spec.md (Spec), architecture-notes.md
  • Meta: rfc.md (RFC), experiment-plan.md

๐ŸŽจ Customization & Extension

Modify Templates

Edit template files under .windsurf/templates/<vendor>/ to adjust section structure or fields.

Add New Company Styles

  1. Create a new directory under .windsurf/templates/
  2. Add corresponding template files
  3. Create a new workflow file under .windsurf/workflows/
  4. Reference templates in workflow: ../templates/<vendor>/<file>.template.md

Trim Document Set

Edit the "Output files" list in the workflow file to remove unwanted documents.

๐Ÿค Contributing

Issues and Pull Requests are welcome!

  • Add other company styles (e.g., Netflix, Apple, OpenAI)
  • Improve existing template structures
  • Fix bugs or improve documentation

๐Ÿ“„ License

MIT License

๐Ÿ”— Related Links

โญ If this project helps you, please give it a Star!