forgecad-high-level-spec

Generate high-level design documents defining problems, alternatives, and decisions.

Updated May 8, 2021
One-click install
npx skills add https://github.com/tamayotchi/dotfiles --skill forgecad-high-level-spec-tamayotchi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: forgecad-high-level-spec
Source: https://github.com/tamayotchi/dotfiles/tree/main/my-forgecad-project/.agents/skills/forgecad-high-level-spec
Command: npx skills add https://github.com/tamayotchi/dotfiles --skill forgecad-high-level-spec-tamayotchi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the creation of high-level design documents (HLDs) for models, mechanisms, or assemblies, ensuring a clear understanding of the design problem and solution space before detailed specification or coding.

Core Features & Use Cases

  • High-Level Design Document Creation: Generate HLDs that define the problem, explore alternatives, and record decisions.
  • Backward Design Approach: Works backwards from requirements, ensuring alignment on what to build before considering how.
  • Document Structure Guidelines: Provides a structured format for HLDs, including problem definition, approach, interfaces, alternatives, usage guide, concerns, and decisions.

Quick Start

Use the forgecad-high-level-spec skill to create a high-level design document for a new model, specifying the problem, approach, and key interfaces.

Frequently Asked Questions about forgecad-high-level-spec

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a high-level design document for mechanical models?

Create a high-level design document by defining the problem, exploring alternatives, and structuring sections for interfaces, usage, and decisions. This Skill streamlines that planning process for mechanical models to ensure alignment before detailed specification.

What should be included in high-level design planning for assemblies?

High-level design planning for assemblies should include problem definition, approach, key interfaces, alternatives, usage guidelines, concerns, and decisions. This structured format ensures a clear understanding of the design problem and solution space before coding.

When do I need an HLD for mechanism design?

You need an HLD for mechanism design when you must establish a clear understanding of the problem and solution space before detailed specification. It works backwards from requirements to ensure team alignment on what to build before considering how.

Do I need prior design knowledge to generate design documentation?

Yes, generating design documentation requires knowledge of design principles and document creation. The Skill provides the structure for design planning and collaboration, but you need foundational mechanical or software design knowledge to fill in the specifics.

What's the best way to structure design documents for new mechanisms?

The best way to structure design documents is using a backward design approach that works backwards from requirements. This ensures alignment on what to build first, structuring the document with problem definitions, approaches, and recorded decisions.

Can I use this approach for both software and mechanical design?

Yes, you can use this approach for both software and mechanical design. The Skill generates high-level design documents for models, mechanisms, or assemblies by defining the problem and exploring alternatives across both domains.