analysis/00-guidelines/
Guidelines
Documentation standards and templates
Documentation standards, naming conventions, and templates used throughout the MASARUK analysis project.
Authoring Principles
Guidelines for writing consistent and clear documentation.
authoring-principles.md
Naming Conventions
Standards for naming files, entities, and variables.
naming-conventions.md
Status Mapping Template
Template for mapping UI status labels to internal enums.
status-mapping-template.md
Portal Audit Report
Comprehensive audit of the documentation portal.
masaruk-docs-portal-audit.md
Review Log
History of all review sessions and decisions.
review-log.md
Core Principles
🎯 Single Source of Truth
All documentation is derived from the analysis/ folder. No invented content.
🔤 Preserve Arabic Text
Arabic text from the UI is preserved exactly as shown. No standardization of Arabic labels.
📋 Evidence-Based Documentation
All features are documented only if evidence exists in screenshots or UI analysis.
🔄 Continuous Update
Documentation is updated as new evidence is discovered or decisions are made.