QUICK-START.md

Быстрая инструкция для создания проекта по стандартам Claude Code Workspace.

🎯 ШАГИ

1. Определите тип проекта

2. Создайте папку проекта

# Для infrastructure проектов
mkdir -p /opt/claude-workspace/projects/@infra-project-name

# Для остальных
mkdir -p /opt/claude-workspace/projects/project-name

cd /opt/claude-workspace/projects/project-name

3. Скопируйте обязательные шаблоны

# Перейти в папку проекта
cd /opt/claude-workspace/projects/project-name

# Скопировать обязательные шаблоны
cp /opt/claude-workspace/templates/README.template.md README.md
cp /opt/claude-workspace/templates/PROJECT-MASTER.template.md PROJECT-NAME-PROJECT-MASTER.md
cp /opt/claude-workspace/templates/CHANGELOG.template.md PROJECT-NAME-CHANGELOG.md
cp /opt/claude-workspace/templates/DOCUMENTATION.template.md DOCUMENTATION.md
cp /opt/claude-workspace/templates/.env.example.template .env.example
cp /opt/claude-workspace/templates/.gitignore.template .gitignore

4. Заполните шаблоны

Откройте каждый файл и замените плейсхолдеры:

Плейсхолдеры для замены:
- {PROJECT_NAME} → имя проекта
- {PROJECT} → короткое имя (для префикса)
- {ДАТА} → текущая дата
- {ОПИСАНИЕ} → описание проекта
- {АВТОР} → ваше имя

:%s/{PROJECT_NAME}/MyProject/g
:%s/{PROJECT}/MP/g
:%s/{ДАТА}/2025-11-08/g

5. Инициализируйте Git

git init
git add .
git commit -m "docs: initial project setup"
git tag v1.0.0 -m "Release v1.0.0"

6. Добавьте опциональные документы (по необходимости)

# Для Application проектов
cp /opt/claude-workspace/templates/ROADMAP.template.md PROJECT-NAME-ROADMAP.md
cp /opt/claude-workspace/templates/ARCHITECTURE.template.md ARCHITECTURE.md
cp /opt/claude-workspace/templates/DEPLOYMENT.template.md DEPLOYMENT.md

# Для проектов с API
cp /opt/claude-workspace/templates/API-GUIDE.template.md PROJECT-NAME-API-GUIDE.md

# Для продакшн проектов
cp /opt/claude-workspace/templates/SECURITY.template.md SECURITY.md

📋 ЧЕКЛИСТ

Обязательно

Опционально

🚀 РАБОТА С CLAUDE CODE

После создания проекта скажите Claude:

Я хочу работать с проектом {PROJECT_NAME}

Claude автоматически прочитает:
- README.md
- DOCUMENTATION.md
- {PROJECT}-PROJECT-MASTER.md

💡 ПРИМЕРЫ

Пример 1: Простой Python скрипт

# 1. Создать проект
mkdir -p /opt/claude-workspace/projects/data-parser
cd /opt/claude-workspace/projects/data-parser

# 2. Минимальные документы
cp /opt/claude-workspace/templates/README.template.md README.md
cp /opt/claude-workspace/templates/.gitignore.template .gitignore

# 3. Заполнить README (вручную или vim)
# 4. Git
git init
git add .
git commit -m "initial commit"

Пример 2: Web приложение (полный набор)

# 1. Создать проект
mkdir -p /opt/claude-workspace/projects/my-web-app
cd /opt/claude-workspace/projects/my-web-app

# 2. Все обязательные шаблоны
cp /opt/claude-workspace/templates/README.template.md README.md
cp /opt/claude-workspace/templates/PROJECT-MASTER.template.md MWA-PROJECT-MASTER.md
cp /opt/claude-workspace/templates/CHANGELOG.template.md MWA-CHANGELOG.md
cp /opt/claude-workspace/templates/DOCUMENTATION.template.md DOCUMENTATION.md
cp /opt/claude-workspace/templates/.env.example.template .env.example
cp /opt/claude-workspace/templates/.gitignore.template .gitignore

# 3. Опциональные для web-app
cp /opt/claude-workspace/templates/ROADMAP.template.md MWA-ROADMAP.md
cp /opt/claude-workspace/templates/ARCHITECTURE.template.md ARCHITECTURE.md
cp /opt/claude-workspace/templates/DEPLOYMENT.template.md DEPLOYMENT.md
cp /opt/claude-workspace/templates/SECURITY.template.md SECURITY.md

# 4. Заполнить все файлы
# 5. Git
git init
git add .
git commit -m "docs: initial project documentation"
git tag v1.0.0

Пример 3: Infrastructure проект

# 1. Создать @infra проект
mkdir -p /opt/claude-workspace/projects/@infra-prod-server
cd /opt/claude-workspace/projects/@infra-prod-server

# 2. Документы для инфраструктуры
cp /opt/claude-workspace/templates/README.template.md README.md
cp /opt/claude-workspace/templates/PROJECT-MASTER.template.md INFRA-PROJECT-MASTER.md
cp /opt/claude-workspace/templates/CHANGELOG.template.md INFRA-CHANGELOG.md
cp /opt/claude-workspace/templates/DEPLOYMENT.template.md DEPLOYMENT.md
cp /opt/claude-workspace/templates/SECURITY.template.md SECURITY.md

# 3. Создать папки для ansible/docker
mkdir -p ansible/playbooks
mkdir -p docker
mkdir -p scripts
mkdir -p configs

# 4. Git
git init
git add .
git commit -m "infra: initial setup"

📚 ДАЛЬНЕЙШИЕ ШАГИ

❓ FAQ

Q: Какие документы обязательны?
A: README, PROJECT-MASTER, CHANGELOG, DOCUMENTATION, .env.example, .gitignore

Q: Когда создавать ROADMAP?
A: Если проект развивается > 3 месяцев

Q: Нужен ли ARCHITECTURE.md для маленького проекта?
A: Нет, достаточно раздела "Архитектура" в PROJECT-MASTER.md

Q: Что делать если забыл создать какой-то документ?
A: Просто скопируйте шаблон и заполните. Документы можно добавлять в любой момент.

Q: Можно ли изменять шаблоны?
A: Да, шаблоны - это отправная точка. Адаптируйте под свои нужды.

⚡ QUICK START - Создание нового проекта