documentation
This skill should be used when the user asks about "update documentation", "CLAUDE.md", "README.md", "documentation conventions", "document this", "add to docs", "update the readme", or discusses project documentation maintenance and standards.
$ 安裝
git clone https://github.com/jwmyers/vui-vux-plugins /tmp/vui-vux-plugins && cp -r /tmp/vui-vux-plugins/plugins/zero-day-dev/skills/documentation ~/.claude/skills/vui-vux-plugins// tip: Run this command in your terminal to install the skill
name: documentation description: This skill should be used when the user asks about "update documentation", "CLAUDE.md", "README.md", "documentation conventions", "document this", "add to docs", "update the readme", or discusses project documentation maintenance and standards. version: 0.2.0
Documentation
Expert knowledge of Zero-Day Attack documentation conventions, structure, and maintenance for CLAUDE.md, README.md, and project documentation.
Documentation Files
CLAUDE.md
Primary guidance file for Claude Code:
| Section | Purpose |
|---|---|
| Project Overview | What the project is |
| Build Commands | How to build/deploy |
| Required Build Configuration | Platform settings |
| Architecture | Code organization |
| Key Namespaces | Namespace purposes |
| Singleton Managers | Global access patterns |
| Board SDK Components | SDK overview |
| Project Structure | File organization |
| SVG Import Settings | Sprite sizing rules |
| Visual Style Guide | Colors summary |
| Layout Configuration | Layout constants |
| Testing | Test instructions |
| Unity MCP Integration | MCP setup/usage |
README.md
User-facing project introduction:
| Section | Purpose |
|---|---|
| Game Overview | What the game is |
| Digitization Approach | Hybrid input model |
| Tech Stack | Engine, platform, SDK |
| Getting Started | Setup instructions |
| Building & Deploying | Build commands |
| Simulation | Testing without hardware |
| Project Structure | Directory overview |
| Documentation | Doc file index |
| AI-Assisted Development | MCP quick start |
| Credits | Attribution |
Documentation Folder
Detailed technical documentation:
| File | Content |
|---|---|
ARCHITECTURE-ANALYSIS.md | Code architecture details |
DIGITIZATION-ANALYSIS.md | Implementation specs |
RULES-ANALYSIS.md | Game mechanics breakdown |
BOARD-TILE-SIZING-ANALYSIS.md | Layout and sizing guide |
game-visual-style-guide.md | Colors and styling |
Unity-MCP-Documentation.md | MCP setup and usage |
ZERO-DAY-ATTACK-rules-instructions.md | Official rulebook |
Board-SDK-Documentation/ | SDK reference manual |
Documentation Conventions
Markdown Formatting
Use consistent formatting:
- Headers:
#for title,##for sections,###for subsections - Code blocks: Triple backticks with language
- Tables: Pipe-separated with header row
- Lists:
-for unordered,1.for ordered
Code Examples
Always include language identifier:
```csharp
public class Example { }
```
```bash
bdb install app.apk
```
Tables
Use for structured data:
| Column 1 | Column 2 |
| -------- | -------- |
| Value 1 | Value 2 |
File References
Use relative paths from project root:
See `Documentation/ARCHITECTURE-ANALYSIS.md`
Located in `Assets/Scripts/Config/`
Updating CLAUDE.md
When to Update
Update CLAUDE.md when:
- New namespaces/classes added
- Architecture changes
- Build process changes
- New SDK features used
- Configuration changes
Update Process
- Identify section needing update
- Keep format consistent with existing sections
- Update related sections if affected
- Keep concise - detail goes in Documentation/
Key Sections to Maintain
Script Organization: Update when adding folders/namespaces
Assets/Scripts/
├── NewFolder/ # Purpose
│ └── NewClass.cs # Description
Key Namespaces: Update when adding namespaces
| `ZeroDayAttack.NewNamespace` | Purpose |
Singleton Managers: Update when adding managers
- `NewManager.Instance` - Description
Updating README.md
When to Update README.md
Update README.md when:
- User-facing features change
- Setup process changes
- Dependencies change
- Credits need updating
Keep User-Focused
README is for users, not AI:
- Clear setup instructions
- Practical examples
- Troubleshooting tips
- Working commands
Documentation Folder Updates
When to Update Documentation Folder Files
Update Documentation files when:
- Significant implementation changes
- New systems added
- Algorithms change
- Rules clarified
Create New Files When
- New major system (e.g., multiplayer)
- Complex feature needing dedicated docs
- External integration guide
Naming Convention
Use UPPERCASE-WITH-DASHES for analysis docs:
NEW-FEATURE-ANALYSIS.md
SYSTEM-NAME-DOCUMENTATION.md
Plugin Documentation
Skills Updates
Update skill SKILL.md files when:
- New trigger phrases needed
- New reference files added
- Procedures change
- Best practices evolve
Agent Updates
Update agent .md files when:
- Expertise changes
- Trigger conditions change
- Tool access changes
Command Updates
Update command .md files when:
- Arguments change
- Behavior changes
- New features added
Documentation Templates
New Feature Documentation Template
# Feature Name Analysis
## Overview
Brief description of the feature.
## Implementation
### Architecture
How it fits in the codebase.
### Key Classes
| Class | Purpose |
| --------- | ----------- |
| ClassName | Description |
### Data Flow
How data moves through the system.
## Usage
How to use the feature.
## Testing
How to test the feature.
API Reference Template
## ClassName
Brief description.
### Properties
| Property | Type | Description |
| -------- | ---- | ------------ |
| Name | Type | What it does |
### Methods
#### MethodName
```csharp
public ReturnType MethodName(ParamType param)
```
Description of method.
**Parameters:**
- `param`: Description
**Returns:** Description
Keeping Docs in Sync
Documentation Checklist
After significant changes:
- CLAUDE.md updated if architecture/build changed
- README.md updated if user-facing changed
- Documentation/*.md updated if systems changed
- Skills updated if domain knowledge changed
- Comments in code are accurate
Cross-Reference Check
Ensure consistency between:
- CLAUDE.md ↔ ARCHITECTURE-ANALYSIS.md
- README.md ↔ CLAUDE.md (no conflicts)
- Skills ↔ Documentation files they reference
Additional Resources
Reference Files
Study existing documentation:
- CLAUDE.md - AI guidance format
- README.md - User documentation format
- Documentation/ARCHITECTURE-ANALYSIS.md - Technical doc format
Style Guidelines
- Concise but complete
- Code examples over prose
- Tables for structured data
- Keep CLAUDE.md actionable
- Keep README.md approachable
Repository
