PROJECT RULES, CODING STANDARDS, WORKFLOW GUIDELINES, REFERENCES, DOCUMENTATION STRUCTURES, AND BEST PRACTICES

This file serves as the central source of truth for all project-related rules, coding standards, workflow guidelines, architectural decisions, references, documentation structures, and best practices. All AI coding assistants interacting with this project MUST adhere to the guidelines outlined in th

promptBeginner5 min to valuemarkdown

0 views

Jan 15, 2026

PROJECT RULES, CODING STANDARDS, WORKFLOW GUIDELINES, REFERENCES, DOCUMENTATION STRUCTURES, AND BEST PRACTICES

HEADERS

PROJECT GOALS & OBJECTIVES

Define the overarching goals of the project.
Outline specific, measurable, achievable, relevant, and time-bound (SMART) objectives.

TECH STACK

Programming languages: [Specify languages used]
Frameworks: [Specify frameworks used]
Libraries: [Specify libraries used]
Databases: [Specify databases used]
Tools: [Specify tools used]
Infrastructure: [Specify infrastructure details]

PROJECT ARCHITECTURE

High-level system architecture.
Module breakdown and dependencies.
Data flow diagrams.
API specifications.

CODING STANDARDS

General:
- Adhere to established coding conventions (e.g., PEP 8 for Python, Google Style Guide for C++).
- Write clean, readable, and well-documented code.
- Use meaningful variable and function names.
- Keep functions short and focused.
- Avoid code duplication (DRY principle).
Specific Languages:
- [Language-specific coding standards, e.g., Python, JavaScript, etc.]
Version Control:
- Use clear and concise commit messages.
- Follow a consistent branching strategy (e.g., Gitflow).
- Code reviews are mandatory before merging changes.

WORKFLOW & RELEASE RULES

Agile development methodologies (e.g., Scrum, Kanban).
Issue tracking and project management tools (e.g., Jira, Trello).
Continuous integration and continuous deployment (CI/CD) pipelines.
Release management procedures.

TESTING

Unit testing: Write unit tests for all critical components.
Integration testing: Verify the interaction between different modules.
End-to-end testing: Test the entire system from the user's perspective.
Test-driven development (TDD): Consider adopting TDD for new features.

DEBUGGING

Use debugging tools and techniques effectively.
Write comprehensive error messages.
Log important events and data for debugging purposes.
Implement proper error handling and exception handling.

PROJECT DOCUMENTATION & CONTEXT SYSTEM

Code Documentation:
- Document all classes, functions, and modules with clear and concise comments.
- Generate API documentation using tools like Sphinx or JSDoc.
Technical Documentation:
- Maintain a comprehensive technical documentation explaining the system architecture, design decisions, and implementation details.
User Documentation:
- Provide user manuals and tutorials for end-users.
Project README:
- Include a detailed README file with instructions on how to set up, build, and run the project.

REFERENCES

Links to relevant documentation, articles, and resources.
Style guides.
API documentation.

BEST PRACTICES

Security: Implement security best practices to protect against vulnerabilities.
Performance: Optimize code for performance and scalability.
Accessibility: Ensure the application is accessible to users with disabilities.
Maintainability: Write code that is easy to maintain and update.

PROJECT RULES, CODING STANDARDS, WORKFLOW GUIDELINES, REFERENCES, DOCUMENTATION STRUCTURES, AND BEST PRACTICES

HEADERS

Define the overarching goals of the project.

Outline specific, measurable, achievable, relevant, and time-bound (SMART) objectives.

Programming languages: [Specify languages used]

Frameworks: [Specify frameworks used]

Libraries: [Specify libraries used]

Databases: [Specify databases used]

Tools: [Specify tools used]

Infrastructure: [Specify infrastructure details]

High-level system architecture.

Module breakdown and dependencies.

Data flow diagrams.

API specifications.

General:

Adhere to established coding conventions (e.g., PEP 8 for Python, Google Style Guide for C++).
Write clean, readable, and well-documented code.
Use meaningful variable and function names.
Keep functions short and focused.
Avoid code duplication (DRY principle).

Specific Languages:

[Language-specific coding standards, e.g., Python, JavaScript, etc.]

Version Control:

Use clear and concise commit messages.
Follow a consistent branching strategy (e.g., Gitflow).
Code reviews are mandatory before merging changes.

Agile development methodologies (e.g., Scrum, Kanban).

Issue tracking and project management tools (e.g., Jira, Trello).

Continuous integration and continuous deployment (CI/CD) pipelines.

Release management procedures.

Unit testing: Write unit tests for all critical components.

Integration testing: Verify the interaction between different modules.

End-to-end testing: Test the entire system from the user's perspective.

Test-driven development (TDD): Consider adopting TDD for new features.

Use debugging tools and techniques effectively.

Write comprehensive error messages.

Log important events and data for debugging purposes.

Implement proper error handling and exception handling.

Code Documentation:

Document all classes, functions, and modules with clear and concise comments.
Generate API documentation using tools like Sphinx or JSDoc.

Technical Documentation:

Maintain a comprehensive technical documentation explaining the system architecture, design decisions, and implementation details.

User Documentation:

Provide user manuals and tutorials for end-users.

Project README:

Include a detailed README file with instructions on how to set up, build, and run the project.

Links to relevant documentation, articles, and resources.

Style guides.

API documentation.

Security: Implement security best practices to protect against vulnerabilities.

Performance: Optimize code for performance and scalability.

Accessibility: Ensure the application is accessible to users with disabilities.

Maintainability: Write code that is easy to maintain and update.

PROJECT RULES, CODING STANDARDS, WORKFLOW GUIDELINES, REFERENCES, DOCUMENTATION STRUCTURES, AND BEST PRACTICES

PROJECT RULES, CODING STANDARDS, WORKFLOW GUIDELINES, REFERENCES, DOCUMENTATION STRUCTURES, AND BEST PRACTICES

HEADERS

PROJECT GOALS & OBJECTIVES

TECH STACK

PROJECT ARCHITECTURE

CODING STANDARDS

WORKFLOW & RELEASE RULES

TESTING

DEBUGGING

PROJECT DOCUMENTATION & CONTEXT SYSTEM

REFERENCES

BEST PRACTICES

Related Skills

Markdown Converter

Nano Banana Pro

1password

PROJECT RULES, CODING STANDARDS, WORKFLOW GUIDELINES, REFERENCES, DOCUMENTATION STRUCTURES, AND BEST PRACTICES

HEADERS

PROJECT GOALS & OBJECTIVES

TECH STACK

PROJECT ARCHITECTURE

CODING STANDARDS

WORKFLOW & RELEASE RULES

TESTING

DEBUGGING

PROJECT DOCUMENTATION & CONTEXT SYSTEM

REFERENCES

BEST PRACTICES