autodoc-agent-kit 1.0.0

package/src/modules/engineering/skills/skill-authoring-workflow/SKILL.md

@@ -0,0 +1,183 @@
+---
+name: skill-authoring-workflow
+description: Turn raw PM content into a compliant, publish-ready skill. Use when creating or updating a repo skill without breaking standards.
+intent: >-
+  Create or update PM skills without chaos. This workflow turns rough notes, workshop content, or half-baked prompt dumps into compliant `skills/<skill-name>/SKILL.md` assets that actually pass validation and belong in this repo.
+type: workflow
+best_for:
+  - "Creating a new repo skill from notes or source material"
+  - "Updating an existing skill while keeping standards intact"
+  - "Running the full authoring and validation workflow before commit"
+scenarios:
+  - "Help me turn these workshop notes into a new PM skill"
+  - "I need to update an existing skill without breaking the repo standards"
+  - "What workflow should I use to author a new skill in this repo?"
+---
+
+## Purpose
+
+Create or update PM skills without chaos. This workflow turns rough notes, workshop content, or half-baked prompt dumps into compliant `skills/<skill-name>/SKILL.md` assets that actually pass validation and belong in this repo.
+
+Use it when you want to ship a new skill without "looks good to me" roulette.
+
+## Key Concepts
+
+### Dogfood First
+
+Use repo-native tools and standards before inventing a custom process:
+- `scripts/find-a-skill.sh`
+- `scripts/add-a-skill.sh`
+- `scripts/build-a-skill.sh`
+- `scripts/test-a-skill.sh`
+- `scripts/check-skill-metadata.py`
+
+### Pick the Right Creation Path
+
+- **Guided wizard (`build-a-skill.sh`)**: Best when you have an idea but not final prose.
+- **Content-first generator (`add-a-skill.sh`)**: Best when you already have source content.
+- **Manual edit + validate**: Best for tightening an existing skill.
+
+### Definition of Done (No Exceptions)
+
+A skill is done only when:
+1. Frontmatter is valid (`name`, `description`, `intent`, `type`)
+2. Section order is compliant
+3. Metadata limits are respected (`name` <= 64 chars, `description` <= 200 chars)
+4. Description says both what the skill does and when to use it
+5. Intent carries the fuller repo-facing summary without replacing the trigger-oriented description
+6. Cross-references resolve
+7. README catalog counts and tables are updated (if adding/removing skills)
+
+### Facilitation Source of Truth
+
+When running this workflow as a guided conversation, use [`workshop-facilitation`](../workshop-facilitation/SKILL.md) as the interaction protocol.
+
+It defines:
+- session heads-up + entry mode (Guided, Context dump, Best guess)
+- one-question turns with plain-language prompts
+- progress labels (for example, Context Qx/8 and Scoring Qx/5)
+- interruption handling and pause/resume behavior
+- numbered recommendations at decision points
+- quick-select numbered response options for regular questions (include `Other (specify)` when useful)
+
+This file defines the workflow sequence and domain-specific outputs. If there is a conflict, follow this file's workflow logic.
+
+## Application
+
+### Phase 1: Preflight (Avoid Duplicate Work)
+
+1. Search for overlapping skills:
+
+```bash
+./scripts/find-a-skill.sh --keyword "<topic>"
+```
+
+2. Decide type:
+- **Component**: one artifact/template
+- **Interactive**: 3-5 adaptive questions + numbered options
+- **Workflow**: multi-phase orchestration
+
+### Phase 2: Generate Draft
+
+If you have source material:
+
+```bash
+./scripts/add-a-skill.sh research/your-framework.md
+```
+
+If you want guided prompts:
+
+```bash
+./scripts/build-a-skill.sh
+```
+
+### Phase 3: Tighten the Skill
+
+Manually review for:
+- Clear "when to use" guidance
+- One concrete example
+- One explicit anti-pattern
+- No filler or vague consultant-speak
+
+### Phase 4: Validate Hard
+
+Run strict checks before thinking about commit:
+
+```bash
+./scripts/test-a-skill.sh --skill <skill-name> --smoke
+python3 scripts/check-skill-metadata.py skills/<skill-name>/SKILL.md
+python3 scripts/check-skill-triggers.py skills/<skill-name>/SKILL.md --show-cases
+```
+
+### Phase 5: Integrate with Repo Docs
+
+If this is a new skill:
+1. Add it to the correct README category table
+2. Update skill totals and category counts
+3. Verify link paths resolve
+
+### Phase 6: Optional Packaging
+
+If targeting Claude custom skill upload:
+
+```bash
+./scripts/zip-a-skill.sh --skill <skill-name>
+# or zip one category:
+./scripts/zip-a-skill.sh --type component --output dist/skill-zips
+# or use a curated starter preset:
+./scripts/zip-a-skill.sh --preset core-pm --output dist/skill-zips
+```
+
+## Examples
+
+### Example: Turn Workshop Notes into a Skill
+
+Input: `research/pricing-workshop-notes.md`  
+Goal: new interactive advisor
+
+```bash
+./scripts/add-a-skill.sh research/pricing-workshop-notes.md
+./scripts/test-a-skill.sh --skill <new-skill-name> --smoke
+python3 scripts/check-skill-metadata.py skills/<new-skill-name>/SKILL.md
+```
+
+Expected result:
+- New skill folder exists
+- Skill passes structural and metadata checks
+- README catalog entry added/updated
+
+### Anti-Pattern Example
+
+"We wrote a cool skill, skipped validation, forgot README counts, and shipped anyway."
+
+Result:
+- Broken references
+- Inconsistent catalog numbers
+- Confusion for contributors and users
+
+## Common Pitfalls
+
+- Shipping vibes, not standards.
+- Choosing `workflow` when the task is really a component template.
+- Bloated descriptions that exceed upload limits.
+- Descriptions that say what the skill is but not when Claude should trigger it.
+- Descriptions that silently hit the 200-char limit and get cut off mid-thought.
+- Letting `intent` become a substitute for a weak trigger description.
+- Forgetting to update README counts after adding a skill.
+- Treating generated output as final without review.
+
+## References
+
+- `README.md`
+- `AGENTS.md`
+- `CLAUDE.md`
+- `docs/Building PM Skills.md`
+- `docs/Add-a-Skill Utility Guide.md`
+- Anthropic's [Complete Guide to Building Skills for Claude](https://resources.anthropic.com/hubfs/The-Complete-Guide-to-Building-Skill-for-Claude.pdf)
+- `scripts/add-a-skill.sh`
+- `scripts/build-a-skill.sh`
+- `scripts/find-a-skill.sh`
+- `scripts/test-a-skill.sh`
+- `scripts/check-skill-metadata.py`
+- `scripts/check-skill-triggers.py`
+- `scripts/zip-a-skill.sh`

package/src/modules/engineering/skills/skill-creator/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.