aif-architecture

Analyze a project's tech stack to generate a tailored ARCHITECTURE.md artifact.

Updated Mar 23, 2024
One-click install
npx skills add https://github.com/Ard2p/sk-bar-site --skill aif-architecture-ard2p
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aif-architecture
Source: https://github.com/Ard2p/sk-bar-site/tree/main/.cursor/skills/aif-architecture
Command: npx skills add https://github.com/Ard2p/sk-bar-site --skill aif-architecture-ard2p

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate architecture guidelines tailored to a project by analyzing the tech stack described in DESCRIPTION.md, and producing a concrete ARCHITECTURE.md artifact.

Core Features & Use Cases

  • Analyzes the project's tech stack from DESCRIPTION.md and optional config to determine a suitable architecture pattern.
  • Generates a structured .ai-factory/ARCHITECTURE.md with rationale, structure, and guardrails tailored to the project.
  • Use cases include starting a new project, deciding "which architecture?", and applying /aif setup to standardize guidelines.

Quick Start

Ask the AI to generate a tailored architecture document for the current project.

Frequently Asked Questions about aif-architecture

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

FAQPage Schema
How do I generate an architecture document for a new software project?

To generate an architecture document, the skill analyzes your tech stack from DESCRIPTION.md to determine a suitable pattern and creates a tailored .ai-factory/ARCHITECTURE.md artifact with structure, rationale, and guardrails.

What is the best way to determine a suitable architecture pattern for my tech stack?

The best way to determine a suitable architecture pattern is to use an AI-guided approach that analyzes your described tech stack and optional config to output standardized project-setup guidelines, structure, and guardrails.

Can I refine an existing architecture using AI-guided guidelines?

Yes, you can refine an existing architecture by applying this skill, which reads optional config.yaml to adapt guidelines to your current codebase and updates the architecture-doc artifact accordingly.

Do I need a DESCRIPTION.md file to standardize project architecture setup?

Yes, you need a DESCRIPTION.md file containing your tech stack because the skill analyzes it to determine the appropriate software-design pattern and generate the architecture guidelines.

How does config.yaml adapt architecture guidelines to the current codebase?

Config.yaml provides optional configuration that the skill reads to adapt and enforce skill-context rules, ensuring the generated architecture-doc aligns with your existing codebase constraints.

When should I not use an automated architecture-doc generator for software design?

You should not use an automated architecture-doc generator if your project lacks a defined tech stack in DESCRIPTION.md, as the tool relies on analyzing those details to determine a suitable architecture pattern.