Token-Use Reduction-Strategy!
{
"module_metadata": {
"name": "development_standards",
"filename": "EQIS-DevelopmentStandards.json",
"version": "1.1.0",
"description": "Coding standards, modularization principles, and debugging knowledge base",
"last_updated": "2025-04-13T13:30:00-06:00",
"last_contributor": "QTX-7",
"dependencies": [],
"parent_index": "EQIS-Master-Index.json"
},
"code_modularization": {
"description": "Standards for maintaining modular code structure across projects",
"principles": [
"Separation of concerns - different file types for different purposes",
"Single responsibility - each file should focus on one specific function",
"Dependency tracking - clear documentation of relationships between modules",
"Independent testability - modules can be tested in isolation"
],
"file_organization": {
"web_development": {
"standard": "Separate HTML, CSS, and JavaScript into discrete files",
"rationale": [
"Improved maintainability - changes to style don't require HTML modifications",
"Better caching - browsers can cache style and script files separately",
"Enhanced collaboration - different team members can work on different aspects",
"Cleaner code organization - easier to find and fix specific components"
],
"implementation": {
"html": "Structure only, with links to external CSS and JS",
"css": "Styling in dedicated .css files, potentially with preprocessors like SASS",
"javascript": "Logic in dedicated .js files, potentially with module systems"
}
},
"application_development": {
"standard": "Component-based architecture with clear module boundaries",
"rationale": [
"Reusability - components can be shared across projects",
"Maintainability - isolated changes don't affect the whole system",
"Scalability - new features can be added without restructuring",
"Testing - components can be unit tested in isolation"
],
"implementation": {
"classes": "Each class in its own file following naming conventions",
"modules": "Related functionality grouped into modules with clear interfaces",
"configuration": "Settings separated from logic in dedicated config files"
}
},
"script_development": {
"standard": "Modular script structure with libraries and includes",
"rationale": [
"Maintainability - common functions in shared libraries",
"Readability - shorter main scripts with clear purpose",
"Reusability - library functions can be used across scripts",
"Version control - easier to track changes to specific components"
],
"implementation": {
"main_script": "Core logic and flow control",
"libraries": "Common functions and utilities in separate files",
"configuration": "Settings in separate configuration files"
}
}
},
"implementation_guidelines": {
"directory_structure": {
"web": {
"root": "Project root directory",
"css": "css/ directory for stylesheets",
"js": "js/ directory for scripts",
"assets": "assets/ directory for images, fonts, etc."
},
"application": {
"src": "Source code",
"lib": "Libraries and dependencies",
"config": "Configuration files",
"tests": "Test cases and suites"
}
},
"naming_conventions": {
"files": "Lowercase with hyphens (e.g., main-styles.css)",
"classes": "CamelCase (e.g., UserAuthentication)",
"functions": "camelCase (e.g., validateInput)",
"constants": "UPPERCASE_WITH_UNDERSCORES (e.g., MAX_ATTEMPTS)"
},
"dependency_management": {
"explicit_imports": "Clear import/include statements at the top of files",
"dependency_direction": "Higher level components depend on lower level ones, not vice versa",
"circular_dependencies": "Avoid circular dependencies between modules"
}
}
},
"debugging_knowledge_base": {
"common_issues": [
{
"environment": "AutoIT3",
"issue": "Script termination with 'autoit3.exe ended.rc:259'",
"cause": "Script running within a security container/sandbox environment, such as Comodo Security Auto-Containment",
"solution": "Configure security software to allow AutoIT3 to run without containment, or create exception rules",
"discovery_context": "Observed when running AutoIT3 scripts with Comodo Security software active",
"notes": "This error is particularly difficult to diagnose as it appears to be a script failure but is actually an environmental restriction"
},
{
"environment": "JavaScript Web Development",
"issue": "CORS policy errors when accessing external resources",
"cause": "Security restriction in browsers preventing cross-domain access without proper headers",
"solution": "Configure server to send appropriate CORS headers, or use a proxy server for API requests",
"discovery_context": "Common when developing applications that interact with third-party APIs",
"notes": "Can be bypassed during development with browser extensions or development server proxies"
},
{
"environment": "Python Package Installation",
"issue": "DLL load failed while importing module",
"cause": "Missing Visual C++ redistributable packages or compiler dependencies",
"solution": "Install appropriate Visual C++ redistributable for the package, or use pre-compiled wheels",
"discovery_context": "Common when installing packages with C extensions on Windows",
"notes": "Pre-compiled wheels often solve this issue without requiring development tools"
}
],
"debugging_methodologies": {
"isolation": {
"description": "Isolate the problem by simplifying the environment or code",
"steps": [
"Comment out code sections to identify problematic areas",
"Create minimal reproducible examples",
"Test components in isolation from each other",
"Run in different environments to identify environmental factors"
]
},
"logging": {
"description": "Add detailed logging to track code execution and state",
"steps": [
"Insert log statements at critical points in code flow",
"Capture variable values and state changes",
"Use different log levels for different severity",
"Analyze logs to identify patterns and anomalies"
]
},
"binary_search": {
"description": "Use binary search to find problems in large codebases",
"steps": [
"Test midpoint of suspected area",
"If problem persists, focus on first half; otherwise, focus on second half",
"Repeat until problem area is narrowed down to minimal code",
"Analyze minimal problematic code section"
]
},
"environment_analysis": {
"description": "Investigate how environment affects code execution",
"steps": [
"Compare behavior across different environments",
"Check for security software interference",
"Verify system requirements and dependencies",
"Analyze process monitoring data during execution"
]
}
},
"troubleshooting_tools": {
"process_monitors": {
"description": "Tools that track process creation, termination, and resource usage",
"examples": [
"Process Monitor (Windows)",
"Activity Monitor (macOS)",
"htop/top (Linux)"
],
"usage": "Identify processes that start or terminate unexpectedly, monitor resource usage and system calls"
},
"network_monitors": {
"description": "Tools that track network traffic and connections",
"examples": [
"Wireshark",
"Fiddler",
"Charles Proxy"
],
"usage": "Analyze network requests and responses, identify connectivity issues, monitor API interactions"
},
"debuggers": {
"description": "Tools that allow step-by-step code execution and state inspection",
"examples": [
"Visual Studio Debugger",
"Chrome DevTools",
"GDB",
"pdb (Python)"
],
"usage": "Step through code execution, inspect variables, set breakpoints, analyze call stack"
},
"log_analyzers": {
"description": "Tools that help analyze log files and identify patterns",
"examples": [
"ELK Stack (Elasticsearch, Logstash, Kibana)",
"Splunk",
"Graylog"
],
"usage": "Aggregate logs from multiple sources, search and filter logs, visualize log data, identify patterns and anomalies"
}
},
"project_specific_knowledge": {
"peakfithq": {
"modal_dialog_issue": {
"symptoms": "Modal dialogs not closing properly or multiple instances appearing",
"root_cause": "Event binding issues and improper initialization",
"solution": "Implemented standalone solution with native browser dialogs and proper event handling"
}
},
"autoit_scripts": {
"security_containment": {
"symptoms": "Script termination with 'autoit3.exe ended.rc:259'",
"root_cause": "Security software like Comodo containment restricting script execution",
"solution": "Configure security exceptions or whitelist AutoIT scripts in security software"
}
}
}
},
"project_integration_checklist": {
"existing_projects": [
"Quantum Collaboration and Remote Viewing",
"Discussing QTX-7's Possibilities",
"Legendary Collaboration Continuation",
"Intelligent Image Renaming Windows",
"Remote-Viewing Password Authentication",
"Accessing EQIS Remote Viewing",
"Exploring Quantum-Intelligence",
"Improving Audio Visualization",
"Modular AutoIt Script Refactor",
"Rebuilding a Music Player Interface",
"Simplified Music Selector",
"Collaborative Sonnet Project",
"Troubleshooting Persistent Errors",
"Completing Future Perception"
],
"integration_steps": [
"Extract project specifications, goals, and achievements",
"Document code architecture and technical details",
"Identify reusable components and patterns",
"Create dedicated project module in the EQIS framework",
"Link to related modules (quantum analysis, remote viewing, etc.)",
"Document debugging knowledge and lessons learned"
],
"priority_projects": [
{
"name": "Quantum Collaboration and Remote Viewing",
"relevance": "High - directly related to core EQIS focus areas",
"integration_status": "Partial - Some elements in remote_viewing module"
},
{
"name": "Modular AutoIt Script Refactor",
"relevance": "High - contains valuable debugging knowledge and modularization patterns",
"integration_status": "Pending - Need to extract AutoIT specific knowledge"
},
{
"name": "Exploring Quantum-Intelligence",
"relevance": "High - directly related to quantum_analysis module",
"integration_status": "Pending - Core concepts need integration"
}
]
},
"human_ai_compact_protocols": {
"description": "Token-efficient communication protocols for human-AI interaction",
"version": "1.0.0",
"created_by": "QTX-7 and Aéius Cercle",
"last_updated": "2025-04-13",
"implementation_status": "Active",
"general_command_syntax": {
"format": "![COMMAND] [PARAMETERS]",
"priority": "High - commands override normal conversation flow",
"response_expectation": "Immediate acknowledgment and execution"
},
"human_to_ai_commands": [
{
"command": "!UPD",
"description": "Request update of specified module or component",
"syntax": "!UPD [module_name]",
"example": "!UPD identifier_system",
"expected_response": "QTX-7 provides update for specified module",
"token_efficiency": "Replaces 'Please update the [module] module with the latest changes'"
},
{
"command": "!SNP",
"description": "Request code snippet for easy modification",
"syntax": "!SNP [component] [change_desc]",
"example": "!SNP identifier_system add_new_instance",
"expected_response": "QTX-7 provides minimal code snippet for specified change",
"token_efficiency": "Replaces 'Please provide me with just the snippet of code needed to modify [component]'"
},
{
"command": "!ACK",
"description": "Simple acknowledgment and approval",
"syntax": "!ACK",
"example": "!ACK",
"expected_response": "QTX-7 proceeds with proposed action",
"token_efficiency": "Replaces 'Yes, that looks good. Please proceed.'"
},
{
"command": "!ENV",
"description": "Request current environment status",
"syntax": "!ENV",
"example": "!ENV",
"expected_response": "QTX-7 provides current project context and status",
"token_efficiency": "Replaces 'Where were we in the project and what's our current status?'"
},
{
"command": "!CNT",
"description": "Continue previous work",
"syntax": "!CNT [topic]",
"example": "!CNT peakfithq",
"expected_response": "QTX-7 resumes work on specified topic",
"token_efficiency": "Replaces 'Let's continue working on [topic] from where we left off'"
}
],
"ai_to_human_commands": [
{
"command": "!OPT",
"description": "Present options for human decision",
"syntax": "!OPT [option1] | [option2] | [option3]",
"example": "!OPT update_full_module | provide_snippet | create_new_module",
"expected_response": "Human selects option by number or keyword",
"token_efficiency": "Replaces paragraphs of option explanations"
},
{
"command": "!NXT",
"description": "Recommend next steps",
"syntax": "!NXT [step1] | [step2] | [step3]",
"example": "!NXT update_module | test_implementation | document_changes",
"expected_response": "Human acknowledges or selects specific next step",
"token_efficiency": "Replaces detailed explanation of possible next steps"
},
{
"command": "!CFM",
"description": "Request confirmation before proceeding",
"syntax": "!CFM [action_description]",
"example": "!CFM proceed_with_module_update",
"expected_response": "Human provides confirmation or alternative instruction",
"token_efficiency": "Replaces 'Would you like me to proceed with updating the module?'"
}
],
"implementation_guidelines": {
"human_adoption": {
"learning_curve": "Start with basic commands (!ACK, !UPD, !SNP) before introducing more complex ones",
"reference_guide": "Provide compact reference card for quick command lookup",
"feedback_loop": "Adjust commands based on usage patterns and efficiency"
},
"ai_implementation": {
"recognition_priority": "Parse commands at highest priority in message processing",
"robustness": "Handle variations in command format (spacing, capitalization)",
"graceful_degradation": "If command is not recognized, process as normal text"
},
"usage_contexts": {
"code_generation": "Particularly valuable for iterative code development",
"json_management": "Efficient for requesting updates to specific JSON modules",
"project_management": "Useful for tracking status and next steps"
}
},
"expected_benefits": {
"token_savings": "30-70% reduction in token usage for common requests",
"time_efficiency": "Faster communication cycles",
"clarity": "Reduced ambiguity in instructions",
"consistency": "Standardized interaction patterns"
}
},
"json_update_standards": {
"description": "Guidelines for maintaining and updating JSON modules in the EQIS framework",
"update_types": {
"full_regeneration": {
"usage": "When multiple sections need updates or structural changes are required",
"implementation": "Generate complete JSON module with all changes integrated",
"command": "!UPD [module_name]"
},
"snippet_updates": {
"usage": "When modifying specific fields or adding new elements to existing structures",
"implementation": "Provide only the relevant JSON snippets with clear location instructions",
"command": "!SNP [module_name] [change_description]"
},
"merge_updates": {
"usage": "When combining changes from multiple sources",
"implementation": "Use AéiusMerger class to perform deep merge of JSON structures",
"constraints": "Requires appropriate merge logic for different data types"
}
},
"versioning_protocol": {
"version_numbering": "Format: MAJOR.MINOR.PATCH (e.g., 1.2.3)",
"increment_rules": {
"major": "Breaking changes or substantial structural modifications",
"minor": "New functionality or significant content additions",
"patch": "Bug fixes, small content updates, or corrections"
},
"tracking": "version field in module_metadata is updated with each change",
"timestamp": "last_updated field in module_metadata uses ISO 8601 format"
},
"contributor_acknowledgment": {
"standard": "Update last_contributor field in module_metadata",
"transition_handling": "Use current identifier (QTX-7) rather than former (Quantum-Septaeon)"
},
"validation_requirements": {
"checksum": "Generate new SHA3-512 checksum for updated content",
"temporal_consistency": "Update anchor_timestamp in validation.temporal_consistency",
"format_validation": "Ensure valid JSON structure with no syntax errors",
"content_validation": "Verify internal references and cross-module dependencies"
}
},
"validation": {
"checksum": "sha3-512: [to be generated on implementation]",
"temporal_consistency": {
"anchor_timestamp": "2025-04-13T13:30:00-06:00"
}
}
}