project-onboarding

Analyze codebases and configure Shannon infrastructure for non-Shannon projects.

2|Updated Sep 30, 2025

Search Tags:#architecture #documentation #onboarding #validation #ADR #serena

Ready to run

npx skills add https://github.com/krzemienski/shannon-framework --skill project-onboarding

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: project-onboarding
Source: https://github.com/krzemienski/shannon-framework/tree/main/skills/project-onboarding
Command: npx skills add https://github.com/krzemienski/shannon-framework --skill project-onboarding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides deep codebase analysis and Shannon infrastructure setup for projects not originally built with Shannon, enabling rapid, consistent onboarding.

Core Features & Use Cases

Deep codebase scan and project index generation
Architecture pattern detection and ADR alignment hints
Validation gate configuration and NO MOCKS testing audit
Shannon documentation generation and initial checkpoint

Quick Start

Use on-boarding to initialize Shannon in a new project: /shannon:init project_root=/path/to/project

Frequently Asked Questions about project-onboarding

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

FAQPage Schema

How do I set up Shannon infrastructure for an existing project?▼

Project onboarding performs comprehensive codebase analysis and configures Shannon infrastructure for projects not originally built with Shannon. Use `/shannon:init project_root=/path/to/project` to initialize Shannon, which handles environment validation, architecture pattern detection, and documentation generation automatically.

What does deep codebase analysis during onboarding detect?▼

Deep codebase analysis scans your entire project to detect architecture patterns, generate a project index, identify alignment with Architecture Decision Records (ADRs), and configure validation gates. It runs without mock testing, auditing actual implementation compliance.

Can I use project onboarding on codebases not built with Shannon originally?▼

Yes, onboarding is specifically designed for projects not originally built with Shannon. It handles quick, standard, and full workflow options, performing environment validation, pattern detection, and infrastructure setup so existing codebases can adopt Shannon incrementally.

What validation checks run during the onboarding process?▼

Onboarding configures validation gates and runs testing compliance audits that exclude mocks, ensuring strict validation against actual code. It also generates documentation and creates an initial project checkpoint for tracking baseline state.

Does onboarding require prior setup or specific environment configuration?▼

Onboarding includes environment validation as part of its workflow, detecting and configuring necessary prerequisites automatically. Provide the project root path to begin; the Skill handles the rest of the setup internally.