SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsquality-ops-doc-gen

quality-ops-doc-gen

Deployment & operations

View repository

Updated 10-16 06:49

About this skill

Quality and Operations Document Generator

Task Objectives

  • This Skill is used to: generate professional test strategy and plan documents, deployment and operations manuals, and security compliance documents
  • Capabilities include: interactive information collection, standard document generation, existing document analysis and optimization, requirement change impact analysis, multi-platform scenario support, and autonomous knowledge completion
  • Trigger conditions: when users need to "generate test documents", "generate operations manuals", "generate security compliance documents", "analyze quality documents", "optimize quality documents", or describe projects that require quality and operations documentation

Prerequisites

Operation Steps

Scenario 1: Generate New Documents

Step 1: Understand Initial Input

  • Read the project description, requirements documents, or code repository provided by the user
  • Identify the project type (Web, mobile, desktop, game, backend service, etc.)
  • Identify the technology stack (programming language, framework, database, deployment environment, etc.)
  • If information is insufficient, proceed to Step 2 to supplement information

Step 2: Interactive Information Supplementation

Based on the document type, interact with the user step by step across the following dimensions:

Test Strategy and Plan Document

  • Project scale and complexity (small/medium/large)
  • Testing type requirements (unit testing, integration testing, E2E testing, performance testing, security testing, etc.)
  • Test coverage targets (unit test coverage, E2E coverage)
  • Multi-platform support status (Web browsers, mobile platforms, desktop operating systems)
  • Game-specific requirements (if applicable): stress testing, frame rate testing, weak network simulation
  • Testing tool preferences (Jest, Cypress, JMeter, Playwright, etc.)
  • Test environment requirements (development environment, testing environment, staging environment)

Deployment and Operations Manual

  • Deployment environment (cloud platform: AWS/Azure/GCP/Alibaba Cloud/Tencent Cloud, or self-built servers)
  • Containerization requirements (Docker, Kubernetes)
  • CI/CD tools (GitLab CI, Jenkins, GitHub Actions, Fastlane, etc.)
  • Monitoring and alerting requirements (Prometheus, Grafana, ELK, Sentry, etc.)
  • Log management solutions (ELK Stack, CloudWatch, Alibaba Cloud Log Service, etc.)
  • High availability requirements (load balancing, disaster recovery backup, elastic scaling)
  • Release strategies (blue-green deployment, canary release, rolling update)

Security Compliance Document

  • Target markets and regions (China, European Union, United States, etc.)
  • Regulations to comply with (GDPR, CCPA, Cybersecurity Law, Classified Protection 2.0, etc.)
  • Data types and sensitivity (personally identifiable information, payment information, health data, etc.)
  • Game license requirements (if applicable): anti-addiction system, real-name authentication, minor protection
  • Third-party SDK list (advertising, analytics, payment, social, etc.)
  • Security certification requirements (ISO 27001, SOC2, etc.)

Step 3: Autonomous knowledge completion (if needed)

  • When encountering a specific technology stack or compliance requirement, use web_search to search:
    • Testing best practices for a specific language/framework
    • Deployment solutions for a specific cloud platform
    • Compliance requirements for a specific region
    • Latest policies for game license application
  • Integrate the search results into the document

Step 4: Generate the document

  • Select the corresponding template based on the document type
  • Fill in the collected information
  • Generate a structured professional document

Test strategy and plan documentIncludes:

  1. Test objectives and scope
  2. Test types and coverage scope (unit testing, integration testing, E2E testing)
  3. Multi-platform compatibility test matrix
  4. Game-specific testing (if applicable)
  5. Test environment and tools
  6. Test progress and milestones
  7. Risks and countermeasures

Deployment and operations manualIncludes:

  1. System architecture and environment description
  2. CI/CD process configuration
  3. Containerization configuration (Docker/Kubernetes)
  4. Deployment steps and verification
  5. Monitoring and alerting system
  6. Log management solution
  7. Failure recovery process
  8. Scaling strategy

Security compliance documentIncludes:

  1. Privacy compliance statement (GDPR/CCPA, etc.)
  2. Data mapping and processing flow
  3. User rights implementation mechanism
  4. Game license application materials (if applicable)
  5. Security certification and audit
  6. Third-party compliance statement
  7. Emergency response process

Step 5: Completeness verification

Scenario 2: Analyze and optimize existing documents

Step 1: Read the existing document

  • Read the quality operations document provided by the user
  • Identify the document type (testing/operations/security)
  • Evaluate document completeness and quality

Step 2: Completeness check

Step 3: Problem diagnosis

Analyze the problems existing in the document:

  • Missing key sections or content
  • Vague descriptions (using words such as "possibly", "probably", etc.)
  • Multi-platform scenarios not covered
  • Outdated or unreasonable technical solutions
  • Compliance requirements not met
  • Incomplete monitoring and alerting configuration

Step 4: Interactive supplementation

  • Interact with the user regarding the problem points to supplement information
  • If multi-platform scenarios are involved, refer to references/multi-platform-testing-guide.md
  • If new technologies or new compliance requirements are involved, use web_search to search for the latest information

Step 5: Generate the optimized version

  • Generate the complete document after supplementation
  • Mark modifications and newly added content
  • Provide a summary of optimization suggestions

Scenario 3: Requirement Change Analysis

Step 1: Read Document Versions

  • Read the original quality operations document
  • Read the new version requirements or change description

Step 2: Comparative Analysis

  • Identify change points:
    • New requirements (Add)
    • Modified requirements (Modify)
    • Deleted requirements (Delete)
  • Mark the functional modules affected by the changes

Step 3: Impact Scope Analysis

Assess the change impact from the following dimensions:

Testing Impact

  • Test cases to be added/modified
  • Test environment changes
  • Test toolchain adjustments
  • Regression testing scope
  • Changes in performance testing requirements

Operations Impact

  • Deployment process changes
  • CI/CD configuration adjustments
  • Monitoring metric changes
  • Alert rule adjustments
  • Changes in resource requirements

Security Impact

  • Compliance requirement changes
  • Data processing flow adjustments
  • Security policy updates
  • Changes in audit requirements

Development Impact

  • Code modules to be modified
  • Technology stack changes
  • Estimated workload
  • Development priority adjustments

Step 4: Output Change Report

Generate a structured change impact report, including:

  • Change list (additions, modifications, deletions)
  • Impact scope assessment (testing/operations/security/development)
  • Risk alerts
  • Implementation recommendations
  • Acceptance criteria

Resource Index

Notes

  • Maintain an interactive supplementary pace, avoid asking too many questions at once
  • Multi-platform scenarios are common omissions and need to be proactively identified and supplemented
  • Prioritize ensuring the document's operability and verifiability
  • When encountering uncertain technical or compliance requirements, proactively search rather than guess
  • After document generation, be sure to use the checklist to verify completeness
  • For game projects, special attention should be paid to game-specific testing and version number compliance
  • Follow the principle of "progressive disclosure", with detailed content linked to reference documents
  • Keep the document up to date, regularly update outdated technical and compliance requirements

Usage Examples

Example 1: Generate a Testing Strategy Document

User input: My project is a React front-end application, and I need to generate a testing strategy document

Execution flow：

  1. Understand the core requirement: testing strategy for a React front-end application
  2. Interactive supplementation:
    • Q: What test types are needed? (Unit testing, integration testing, E2E testing?)
    • Q: What is the target coverage? (e.g., unit testing ≥80%)
    • Q: Which browsers need to be supported? (Chrome, Safari, Firefox, Edge)
    • Q: Is mobile support needed? (Responsive or standalone mobile)
    • Q: Testing tool preference? (Jest, Cypress, Playwright)
  3. Generate test strategy document
  4. Validate using checklist
  5. Output complete document

Example 2: Generate deployment and operations manual

User input: I want to deploy a Node.js backend service to AWS, and need a deployment and operations manual

Execution flow：

  1. Understand the core requirement: deploy a Node.js service to AWS
  2. Interactive supplementation:
    • Q: Which AWS services will be used? (EC2, ECS, Lambda, RDS, etc.)
    • Q: Will containerization be used? (Docker, Kubernetes)
    • Q: CI/CD tools? (GitLab CI, GitHub Actions, Jenkins)
    • Q: Monitoring and alerting requirements? (Prometheus, Grafana, CloudWatch)
    • Q: Log management solution? (ELK, CloudWatch Logs)
    • Q: High availability requirements? (Load balancing, multi-AZ deployment)
  3. Search for AWS deployment best practices
  4. Generate deployment and operations manual
  5. Validate using checklist
  6. Output complete document

Example 3: Generate security compliance document

User input: My game needs to launch in China, and I need a security compliance document

Execution flow：

  1. Understand the core requirement: the game will launch in China and needs compliance documents
  2. Interactive supplementation:
    • Q: Game type? (Mobile game, client game, browser game)
    • Q: Target user age? (Whether minors are involved)
    • Q: Is a publication number required? (Required for commercial games)
    • Q: Data types? (Personally identifiable information, payment information, etc.)
    • Q: Third-party SDKs? (Advertising, analytics, payment, social, etc.)
    • Q: Server deployment location? (Must be within China)
  3. Search for the latest policies on game publication number applications
  4. Generate security compliance document, including:
    • Anti-addiction system implementation
    • Real-name authentication solution
    • Minor protection measures
    • Cybersecurity Classified Protection 2.0 filing
    • Publication number application materials checklist
  5. Validate using checklist
  6. Output complete document

Example 4: Analyze and optimize existing documents

User input: This is my test strategy document, please help me see what problems there are [upload document]

Execution flow：

  1. Read and analyze the document
  2. Validate item by item using the checklist:
    • ✓ Test objectives are clear
    • ✗ Multi-platform compatibility testing is missing
    • ✗ Game-specific testing is not covered (if it is a game project)
    • ✓ Test tool descriptions are complete
  3. Interactively supplement missing information
  4. Generate an optimized version, marking newly added content
  5. Provide a summary of optimization suggestions

Example 5: Requirement change analysis

User input: The original deployment plan was single-machine deployment, now it needs to be changed to Kubernetes cluster deployment, please analyze the impact

Execution flow：

  1. Compare the original document (single-machine deployment) with the new requirement (Kubernetes cluster)
  2. Identify changes:
    • Added: Kubernetes cluster configuration
    • Changed: Deployment process changed from direct deployment to containerized deployment
    • Added: Service discovery and load balancing
    • Added: Auto-scaling strategy
  3. Analyze impact:
    • Testing: Need to add Kubernetes environment testing
    • Operations: Need to configure Kubernetes monitoring and logging
    • Development: Need to adapt to containerized deployment
    • Security: Need to configure Kubernetes security policies
  4. Output change impact report

Multi-platform scenario support

Web applications

  • Browser compatibility: Chrome, Safari, Firefox, Edge (latest 2-3 versions)
  • Responsive design: Desktop, tablet, mobile
  • Testing tools: Cypress, Playwright, BrowserStack

Mobile applications

  • iOS：iPhone 12-15，iOS 15+
  • Android: Mid-to-high-end models from mainstream manufacturers, Android 10+
  • Testing tools: XCTest, Espresso, Appium, Firebase Test Lab

Desktop applications

  • Windows：Windows 10/11
  • macOS：Monterey+
  • Linux：Ubuntu 20.04+、Fedora 35+

Game applications

  • Platforms: PC, consoles (PS5, Xbox Series X/S), mobile
  • Specialized testing: Frame rate, stress, weak network, compatibility
  • Testing tools: Unity Profiler, JMeter, Locust

Technology stack support

Frontend

  • Frameworks: React, Vue, Angular, Svelte
  • Testing: Jest, Vitest, Cypress, Playwright, Testing Library
  • Build: Vite, Webpack, Rollup

Backend

  • Languages: Node.js, Python, Java, Go, C#, PHP
  • Frameworks: Express, Django, Spring Boot, Gin, ASP.NET
  • Testing: Jest, Pytest, JUnit, Go Test, xUnit

Mobile

  • Cross-platform: React Native, Flutter, Ionic
  • Native: iOS (Swift), Android (Kotlin)
  • Testing: XCTest, Espresso, Detox, Appium

Game engines

  • Engines: Unity, Unreal Engine, Godot, Cocos
  • Testing: Unity Test Runner, Unreal Automation System

Deployment platforms

  • Cloud platforms: AWS, Azure, GCP, Alibaba Cloud, Tencent Cloud
  • Containers: Docker, Kubernetes
  • CI/CD：GitLab CI、GitHub Actions、Jenkins、CircleCI