sample-customize-product-brief.toml 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. # DO NOT EDIT -- overwritten on every update.
  2. #
  3. # Workflow customization surface for bmad-product-brief.
  4. #
  5. # Override files (not edited here):
  6. # {project-root}/_bmad/custom/bmad-product-brief.toml (team)
  7. # {project-root}/_bmad/custom/bmad-product-brief.user.toml (personal)
  8. [workflow]
  9. # --- Configurable below. Overrides merge per BMad structural rules: ---
  10. # scalars: override wins • arrays: append
  11. # Steps to run before the standard activation (config load, greet).
  12. # Use for pre-flight loads, compliance checks, etc.
  13. activation_steps_prepend = []
  14. # Steps to run after greet but before the workflow begins.
  15. # Use for context-heavy setup that should happen once the user has been acknowledged.
  16. activation_steps_append = []
  17. # Persistent facts the workflow keeps in mind for the whole run
  18. # (standards, compliance constraints, stylistic guardrails).
  19. # Each entry is either a literal sentence, a skill prefixed with `skill:`, or a `file:`-prefixed path/glob
  20. # whose contents are loaded as facts.
  21. # Default is empty. Common opt-ins (set in your team/user override TOML):
  22. # "file:{project-root}/_bmad-output/planning-artifacts/project-context.md" # bmad-generate-project-context output
  23. # "skill:acme-co:terms-and-conditions" # a skill that contains some relevant info to the documents that may be generated
  24. # "Elvis has left the building" # generic agent instructions
  25. persistent_facts = []
  26. # Executed when the workflow completes (after the user has been told the
  27. # brief is ready). Accepts either a string scalar (single instruction)
  28. # or an array of instructions executed in order. Empty for none.
  29. on_complete = ""
  30. # Default brief structure. Treated as a starting point — the LLM adapts it
  31. # to the product, purpose, and domain. Override the path in team/user TOML
  32. # to enforce a different structure (e.g. regulated-industry, investor-deck).
  33. brief_template = "assets/brief-template.md"
  34. # Run folder location. The brief, optional addendum, and optional distillate
  35. # all land inside `{output_dir}/{output_folder_name}/`.
  36. output_dir = "{planning_artifacts}/briefs"
  37. output_folder_name = "brief-{project_name}-{date}"
  38. # Document standards applied to human-consumed docs at finalize. Each entry is
  39. # a `skill:`, `file:`, or plain-text directive; the parent LLM applies the
  40. # findings before the user sees the draft. Encodes standards, not options.
  41. #
  42. # Examples:
  43. # "skill:bmad-editorial-review-prose"
  44. # "file:{project-root}/_bmad/style-guides/company-voice.md"
  45. # "Convert all dates to ISO 8601 format."
  46. #
  47. # Suggested order (broader passes first, narrower last):
  48. # 1. Structural (cuts, reorganization, section sizing)
  49. # 2. Content/voice/conventions (org standards, tone, terminology, compliance)
  50. # 3. Prose mechanics (grammar, clarity, typos)
  51. #
  52. # Override the array in team/user TOML to add additional standards. Append-only:
  53. # base entries cannot be removed or replaced (resolver has no removal mechanism).
  54. doc_standards = [
  55. "skill:bmad-editorial-review-structure",
  56. "skill:bmad-editorial-review-prose",
  57. ]