Files
librefang-registry/workflows/refactor-plan.toml
T
Evan 05bdf02169 feat(workflows): expand template library from 9 to 22 + multiline string cleanup (#36)
* feat(workflows): add 13 workflow templates across engineering, business, and productivity

Engineering:
- bug-triage: reproduce path → root cause → fix plan
- api-design: resource model → endpoints → OpenAPI spec
- incident-postmortem: timeline → RCA → full postmortem report
- test-generation: code analysis → edge cases → full test suite
- refactor-plan: smell analysis → prioritised opportunities → migration plan

Business:
- competitor-analysis: profiles → SWOT → strategy report
- product-spec: problem definition → user stories → full PRD
- market-research: landscape → segments → research report

Productivity/Thinking:
- meeting-summary: raw notes → structured summary → follow-up email
- decision-matrix: criteria → weighted scoring → recommendation memo
- learning-plan: gap analysis → roadmap → week-1 day-by-day plan
- job-application: job analysis → tailored resume → cover letter → interview prep
- blog-post: research → outline → draft → SEO optimisation

Closes #1912 on librefang/librefang

* fix(workflows): overhaul existing 9 templates

- data-pipeline: redesigned — original 'extract from URL' step was
  broken (LLMs cannot fetch URLs); replaced with paste-data approach
  (profile → clean_transform → analyse) with analysis_goal parameter
- translate-polish: added target_language and register parameters;
  added back-translation step for accuracy verification
- weekly-report: added team/audience parameters, richer extraction
  step, added Metrics and Notes sections
- content-pipeline: added audience/tone parameters, added outline step
  between research and writing
- content-review: fix category 'content' → 'creation'
- customer-support: fix category 'support' → 'business'

* style(workflows): convert all prompt_template strings to TOML multiline syntax

Replace \n escape sequences with real newlines using triple-quote
multiline strings ("""...""") across all 22 workflow templates.
No content changes — formatting only.

* style(hands): replace \n escape in reddit writer format example with multiline code block
2026-04-01 18:21:09 +08:00

82 lines
2.2 KiB
TOML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
id = "refactor-plan"
name = "Refactor Plan"
description = "Analyse code for quality issues, prioritise refactoring opportunities, and produce a safe incremental migration plan."
category = "engineering"
tags = ["refactoring", "code-quality", "engineering", "architecture"]
[i18n.zh]
name = "重构计划"
description = "分析代码质量问题,优先排序重构机会,制定安全的增量迁移计划。"
[[parameters]]
name = "code"
description = "Code to refactor"
param_type = "string"
required = true
[[parameters]]
name = "context"
description = "Why refactoring is being considered (performance, maintainability, tech debt)"
param_type = "string"
required = false
default = "general code quality improvement"
[[steps]]
name = "smell_analysis"
prompt_template = """
You are a senior software architect performing a code quality audit. Identify all code smells and issues:
For each issue found:
- Category: naming / duplication / complexity / coupling / abstraction / performance / security
- Severity: critical / high / medium / low
- Location: function/class name
- Description: what is wrong
- Impact: why it matters
Context: {{context}}
Code:
{{code}}
"""
[[steps]]
name = "prioritised_opportunities"
prompt_template = """
Prioritise refactoring opportunities by: (impact × risk_reduction) / effort.
For the top 5 opportunities:
- What to change
- Expected benefit
- Estimated effort: hours
- Risk level: low / medium / high
- Prerequisites: what must be done first
- Whether tests are needed before refactoring
Smell analysis:
{{smell_analysis}}
"""
depends_on = ["smell_analysis"]
[[steps]]
name = "migration_plan"
prompt_template = """
Design an incremental refactoring plan that keeps the system working throughout:
**Phase 1 — Safety net** (tests and coverage)
**Phase 2 — Low-risk quick wins**
**Phase 3 — Structural changes**
**Phase 4 — Validation and cleanup**
For each phase:
- Specific changes in order
- How to verify nothing broke after each change
- Rollback strategy
- Definition of done
Also note: what NOT to change in this refactoring cycle.
Prioritised opportunities:
{{prioritised_opportunities}}
"""
depends_on = ["prioritised_opportunities"]