Markdown Editor

小型软件团队套件

小团队的轻量文档:PRD、精简 SRS、设计文档、ADR、RFC、技术探针、规范、提交、PR、测试与发布。

14 个模板,按使用顺序分为 5 步。在编辑器中打开任一模板,填写后可导出为 PDF、DOCX 或 HTML。

第 1 步

规划

  1. Product Requirements Document (PRD) Template

    完整

    Lean path or full PRD: evidence, metrics with baseline and guardrails, non-goals, user flow, FR table with acceptance criteria, UX states, NFRs, privacy, events, rollout gates

    ISO/IEC 25010:2023 (NFR categories, cited); WCAG 2.2
  2. Lightweight SRS Template for Small Teams

    标准

    Lightweight SRS for one small team, aligned with ISO/IEC/IEEE 29148:2018: scope, users, functional, non-functional and interface requirements, verification

    ISO/IEC/IEEE 29148:2018 (light); replaces IEEE 830
  3. Spike Report Template

    精简

    Time-boxed technical investigation: question, success criteria, approach, findings with evidence, risks, recommendation and next steps

第 2 步

决策

  1. Software Design Document Template

    标准

    Lean feature design doc: context, goals and non-goals, design, API and data changes, alternatives, cross-cutting concerns, rollout

  2. Architecture Decision Record (ADR) Template

    标准

    Lightweight Nygard-style ADR: status, context, decision, consequences, alternatives, related decisions, lifecycle and log

    Michael Nygard ADR format (2011)
  3. RFC Template (Request for Comments)

    标准

    RFC proposal: summary, motivation, guide-level explanation, detailed design, drawbacks, alternatives, prior art, rollout, decision

    Rust RFC process (section structure)
第 3 步

构建

  1. Coding Standards Template

    标准

    Team coding standards: naming, tool-enforced formatting, structure, errors, logging, tests, reviews, language rules

  2. Branching Strategy Template (Trunk-Based, SLSA Source)

    完整

    Branching standard: model selection, naming, MUST/SHOULD rules, ruleset settings, SLSA Source mapping, merging, release branches, hotfixes, exceptions, metrics

    SLSA 1.2 Source track; DORA trunk-based development; Conventional Commits 1.0.0
  3. Commit Message Convention Template

    标准

    Commit message standard: Conventional Commits structure, types and SemVer effect, scopes, breaking changes, footers and trailers, examples, commitlint and release tooling

    Conventional Commits 1.0.0; SemVer 2.0.0
  4. Pull Request Description Template

    精简

    PR description: summary with closing keyword, type of change, breaking changes and migration, test plan, security, AI assistance disclosure

    GitHub pull request templates; Conventional Commits 1.0.0; SemVer 2.0.0; DCO 1.1
第 4 步

验证

  1. Test Plan Template

    标准

    Practical feature or release test plan: scope, risks, approach per level, cases, environments, entry/exit criteria

  2. Code Review Checklist Template

    标准

    Team code review agreement: review types (ISO/IEC 20246, IEEE 1028), roles, checklist with OWASP Top 10:2025 mapping and AI-assisted code items, labels, PR size, SLA

    ISO/IEC 20246:2017; IEEE 1028-2008; OWASP Top 10:2025
第 5 步

发布与移交

  1. Software Release Checklist Template (Staged Rollout, SBOM, VEX)

    完整

    Per-release checklist: planning and pre-mortem, freeze, QA, security, 2026 SBOM fields, VEX and advisories, signing, ring rollout, emergency rollback, sign-offs

    CISA Safe Software Deployment (2024); CISA 2026 SBOM Minimum Elements; NIST SSDF 1.1
  2. Changelog Template (Keep a Changelog)

    标准

    CHANGELOG.md in Keep a Changelog 1.1.0 format: Unreleased, six change types, YANKED, comparison links, maintainers' guide with SemVer 2.0.0 mapping

    Keep a Changelog 1.1.0; Semantic Versioning 2.0.0