القائمة
Standard structure and templates for Architecture documents (docs/ARCHITECTURE.md).
يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.
اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/MatrixFounder/Agentic-development --skill architecture-formatيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
Standards for code documentation, comments, and artifact updates.
Detailed checklist for verifying System Architecture and Data Models.
Structured checklist for code review: bugs, style, performance, security, docs.
عرض SKILL.md
استنادا إلى تصنيف SOC المهني
| name | architecture-format |
| description | Standard structure and templates for Architecture documents (docs/ARCHITECTURE.md). |
| version | 1 |
Your architecture must contain the following sections:
Link to TASK and brief summary of requirements
Description of the system in terms of functions it performs.
For each functional component describe:
Component Name: [Example, "User Management"]
Purpose: [Why this component is needed]
Functions:
Function 1: [Description]
Function 2: [Description]
Dependencies:
[Mermaid diagram showing connections between components]
Description of the system in terms of physical/logical components.
Which architectural pattern is used:
Justification: [Why this style was chosen]
For each system component describe:
Component Name: [Example, "User Service"]
Type: [Backend service / Frontend / Database / Message Queue / etc.]
Purpose: [Why needed]
Implemented Functions: [Links to functions from functional architecture]
Technologies: [Programming language, frameworks]
Interfaces:
Dependencies:
[Mermaid diagram showing components and their interaction]
Description of data structure in the system.
Description of main entities and their relationships at a high level.
Entities:
Description: [What this entity represents]
Attributes:
id (UUID) — unique identifieremail (String, unique) — user emailpassword_hash (String) — password hashcreated_at (DateTime) — creation datestatus (Enum: pending, active, blocked) — account statusRelationships:
Business Rules:
...
More detailed description considering storage technology.
For Relational DB:
users| Column | Type | Constraints | Description |
|---|---|---|---|
| id | UUID | PRIMARY KEY | Unique identifier |
| VARCHAR(255) | UNIQUE, NOT NULL | User email | |
| password_hash | VARCHAR(255) | NOT NULL | Bcrypt password hash |
| created_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | Creation date |
| updated_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | Update date |
| status | VARCHAR(20) | NOT NULL, DEFAULT 'pending' | Account status |
Indexes:
idemailstatus (for filtering)Foreign Keys:
For NoSQL DB:
users{
"_id": "ObjectId",
"email": "string (unique)",
"password_hash": "string",
"created_at": "ISODate",
"updated_at": "ISODate",
"status": "string (enum: pending, active, blocked)",
"profile": {
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
},
"sessions": [
{
"token": "string",
"created_at": "ISODate",
"expires_at": "ISODate"
}
Indexes:
emailstatussessions.expires_at[ER-diagram in PlantUML format]
Example:
┌─────────────┐ ┌─────────────┐
│ User │ │ Session │
├─────────────┤ ├─────────────┤
│ id (PK) │────────<│ user_id(FK) │
│ email │ 1:N │ token │
│ password │ │ expires_at │
└─────────────┘ └─────────────┘
Migration Strategy: [How DB schema changes will be executed]
For modification of existing system:
For each external API describe:
Protocol: REST / GraphQL / gRPC / WebSocket
Base URL: /api/v1/users
Authentication: JWT Bearer Token
Endpoints:
Description: New user registration
Related Use Case: UC-01
Request:
{
"email": "string (required, email format)",
"password": "string (required, min 8 chars)",
"password_confirmation": "string (required)"
}
Response 201 Created:
{
"user_id": "uuid",
"email": "string",
"status": "pending",
"message": "Confirmation email sent"
}
Response 400 Bad Request:
{
"error": "validation_error",
"details": {
"email": ["Email already exists"],
"password": ["Password too short"]
}
}
Response 500 Internal Server Error:
{
"error": "internal_error",
"message": "Failed to send confirmation email"
}
[Description of next endpoint]
Description of interaction between system components.
Protocol: Message Queue (RabbitMQ)
Exchange: notifications
Routing Key: email.confirmation
Message Format:
{
"user_id": "uuid",
"email": "string",
"confirmation_token": "string",
"template": "user_confirmation"
}
If system integrates with external services:
Purpose: Sending email notifications
Protocol: REST API
Authentication: API Key
Endpoints Used:
Error Handling:
Programming Language: [Python / Java / Node.js / etc.]
Framework: [Django / Spring Boot / Express / etc.]
Justification: [Why these technologies were chosen]
Framework: [React / Vue / Angular / etc.]
Justification:
Type: [PostgreSQL / MongoDB / Redis / etc.]
Justification:
Containerization: Docker
Orchestration: Kubernetes / Docker Compose
Message Queue: RabbitMQ / Kafka / Redis
Caching: Redis / Memcached
Monitoring: Prometheus + Grafana
Logging: ELK Stack / Loki
Used Technologies: [List of technologies already in project]
New Technologies: [What needs to be added and why]
Compatibility: [How new technologies integrate with existing ones]
Auth Mechanism: JWT / OAuth 2.0 / Session-based
Password Storage: Bcrypt / Argon2
Session Management:
Encryption:
Personal Data:
OWASP Top 10:
Rate Limiting:
Horizontal Scaling:
Vertical Scaling:
What is cached:
Cache Invalidation Strategy:
Indexes: [Which indexes are critical for performance]
Partitioning: [If applicable]
Replication: [Master-Slave, Master-Master]
Strategy:
What is backed up:
Backup Frequency:
Backup Storage:
Metrics:
Alerts:
Development: [Description of dev environment]
Staging: [Description of staging environment]
Production: [Description of prod environment]
Stages:
Tools:
Configuration Management:
For New Project:
For Modification of Existing Project:
List of questions requiring clarification from user.