The TXT File: New Comment Specification
THE CRAFT™️ EXPERIMENT :: WEEK 2 :: POST 4
< Previous Page | Page 4 of 5 | Next Page >
We will provide this text file to 3 A.I. chat tools to test it.
THE TEXT FILE:
# ================================================
# CRAFT FRAMEWORK SPECIFICATION
# File: CRAFT-SPEC_V04282025A.txt
# Version: 04282025A
# ================================================
"""
This file contains the complete and current specification for the CRAFT
(Configurable Reusable AI Framework Technology) framework. It defines:
1. The purpose and philosophy of the CRAFT framework
2. Detailed explanations of all core components with syntax rules and conventions
The specification serves as the authoritative reference for the CRAFT
framework and should be consulted when questions arise about proper
implementation. This document evolves as the framework matures.
The version number follows the format MMDDYYYYX where X is a letter (A-Z)
that increases with each revision made on the same day.
This specification file should be shared with AI assistants at the beginning
of each new chat session to ensure consistent understanding of the framework.
"""
# For all of the files in this CRAFT framework, the content in different sections will include standard text, Python or HTML. To clearly identify these sections, the following system should be followed:
### START REGULAR TEXT BLOCK ###
Everything in between these comment blocks is regular text and should be read by the A.I. the same way that any normal text file would be read. It will include things like prompts, information, instructions and more
### END REGULAR TEXT BLOCK ###
### START PYTHON CODE BLOCK ###
# Everything in between these comment blocks is Python
### END PYTHON CODE BLOCK ###
### START HTML BLOCK ###
<!-- Everything in between these comment blocks is HTML -->
### END HTML BLOCK ###
# Doing this will allow me to copy and paste HTML and Python directly from my chats into this text document and similar text files
### START PYTHON CODE BLOCK ###
####################################################
### 1. The purpose and philosophy of the CRAFT framework ###
####################################################
"""
The CRAFT (Configurable Reusable AI Framework Technology) framework was designed
to transform casual AI interactions into structured, efficient workflows by
adapting principles of object-oriented programming to AI conversations.
## Core Purpose
CRAFT exists to solve fundamental challenges in human-AI collaboration:
- Inconsistency in AI responses across multiple sessions
- Loss of context between conversations
- Inefficiency from repetitive instructions
- Lack of structure in complex AI projects
- Difficulty maintaining state across separate AI interactions
## Guiding Philosophy
CRAFT is built on five key philosophical principles:
1. STRUCTURE ENABLES FREEDOM: By providing a clear framework for AI interaction,
CRAFT paradoxically creates more creative freedom by eliminating cognitive
overhead and repetition.
2. CODE AS CONVERSATION: Programming concepts like variables, functions, and
objects can dramatically improve the clarity and efficiency of natural
language exchanges with AI.
3. CUMULATIVE INTELLIGENCE: AI interactions should build upon each other,
creating an evolving knowledge base rather than isolated conversations.
4. HUMAN-AI PARTNERSHIP: The framework facilitates true collaboration where
both human creativity and AI capabilities are leveraged optimally.
5. ACCESSIBILITY THROUGH FAMILIARITY: Using Python-like syntax creates an
approachable system for both technical and non-technical users.
## Practical Application
CRAFT is designed to excel in scenarios requiring:
- Complex, multi-session projects
- Consistent outputs across different AI models
- Knowledge preservation between conversations
- Efficient reuse of common elements
- Structured collaboration between humans and AI
The framework is programming-inspired but focused on natural language
interaction, creating a hybrid approach that bridges conventional coding
and conversational AI engagement.
This document represents the current state of the CRAFT™️ Framework as of April 2025. The framework is actively evolving through ongoing experimentation and collaborative development.
"""
#############################################
### 2. Detailed explanations of all core components ###
#############################################
#################
### COMMENTS ###
#################
# Comments match the Python Standard
# This is a single-line comment
x = 5 # This comment explains what x is
# This is a
# multi-line
# comment
"""
This is also a
multi-line
comment,
but technically a string literal.
"""
"""
Section Separators
Use long comment lines to mark phases or stages:
#########################
### SECTION SEPARATORS ###
#########################
"""
"""
NAMING CONVENTIONS - Unless specified, we will use the standard naming conventions for Python. As I will be working with multiple A.I. chat tools, I will be copying and pasting Python code from them when it is needed. They may provide valid Python that differs slightly from my own naming preferences. My preferences include:
As with Python, variables use snake case and are words are separated by underscores (e.g., my_variable, user_name).
As with Python, class names use Pascal case and start with a capital letter (e.g., MyVariable, UserName).
As with Python, constants are uppercase words separated by underscores (e.g., PI, MAX_VALUE).
All other names fit standard Python naming conventions.
"""
# Use of Comments in CRAFT that expand on the Python standard
#The comments include these 2 variations indicating the source of the communication and the audience. Since the communication takes place between a Human User and an AI, there are 2 variations:
# Communication from the Human to the AI will begin with "#H->AI::"
#H->AI::
# Drawing inspiration from code comments but tailoring them for AI interaction, we will use #H->AI:: as a potential prefix, followed by a keyword indicating the communication type and a description in ().
#H->AI::Directive: (Command/Instruction. Explicit commands telling the AI what to do or how to behave. This goes beyond the core prompt request. )
#H->AI::Context: (Background/Setting. Provides background information, situational context, assumptions, or constraints the AI should factor into its reasoning and response. Sets the stage. )
#H->AI::Constraint: (Limitation/Boundary. Defines specific limitations, boundaries, or things the AI must not do. More specific than general context. )
#H->AI::Focus: (Emphasis/Priority. Highlights specific parts of the prompt or aspects of the task that require special attention or prioritization. Guides the AI's focus. )
#H->AI::Question: (Direct Inquiry for AI. Poses a direct question to the AI that requires an explicit answer within the response, often metacognitive or clarifying. )
#H->AI::Consider:(Implicit Guidance/Food for Thought. Provides information or questions the AI should consider or factor into its reasoning without necessarily needing to address it directly or explicitly in the output. Subtle guidance. )
#H->AI::Define: (Terminology/Concept Definition. Defines a specific term, acronym, or concept as it should be understood and used by the AI within this interaction context. Ensures alignment.)
#H->AI::Role: (Assume a New Role. Change the Role or Persona That the AI Assumes. )
#H->AI::Structure: (Output Formatting. Specifies requirements for the structure, layout, or format of the AI's response. )
#H->AI::Metadata: (Contextual Info about the Prompt. Provides metadata about the prompt itself for tracking, versioning, or linking purposes, potentially useful for the AI in complex, multi-turn scenarios or for your CRAFT™️ system.)
#H->AI::OnError: (Contingency/Fallback Plan. Specifies how the AI should respond or what it should do if it encounters an error, cannot fulfill a request, or lacks necessary information.)
#H->AI::UseSource: (Knowledge Source Specification. Directs the AI to prioritize or exclusively use specific documents, data sets, previous conversation parts, or knowledge domains when generating its response.)
#H->AI::Illustrate: (Request for Examples/Analogies. Asks the AI to include specific examples, analogies, metaphors, or case studies to clarify complex points or make the content more relatable.)
#H->AI::EvaluateBy: (Success Criteria Definition. Defines the criteria by which the user will judge the success or quality of the AI's response. Helps the AI understand priorities for quality.)
#H->AI::DetailLevel: (Verbosity/Granularity Control. Sets the desired level of detail, technical depth, or verbosity for the AI's response or specific sections thereof.)
#H->AI::Perspective: (Viewpoint Adoption/Comparison. Instructs the AI to adopt a specific viewpoint, role (beyond just persona), or to analyze a topic from multiple perspectives.)
#H->AI::InputPurpose: (Clarifying User Input Intent. Explains why a specific piece of information is being provided to the AI, guiding its interpretation and use of that input.)
#H->AI::Review: (Self-Correction/Refinement Request. Asks the AI to review its own generated output against specific criteria and potentially revise it before presenting the final response.)
#H->AI::Reasoning: (Process Transparency Request. Asks the AI to explain its reasoning process, show its work, or follow a specific thinking methodology (e.g., step-by-step, pros/cons).)
#H->AI::CreateImage: (Image Creation Request)
#H->AI::CreateChartGraph: (Chart or Graph Request)
#H->AI::CreateImagePrompt: (Image Prompt Creation Request)
#H->AI::Placeholder: (Marks a spot where something will be changed and tells the AI to replace the placeholder with the specified value)
#H->AI::NOP: (No-operation. Log this user‑journey step without generating text.)
#H->AI::Note: ()
#H->AI::Set: ()
#H->AI::Summarize: ()
#H->AI::Explain: ()
#H->AI::Status: ()
#H->AI::Lock: (Lock a segment of code)
#H->AI::Unlock: (Unlock a segment of code)
#H->AI::DeDuplicate: (Find and delete duplicate bits of code or logic)
# Communication from the AI to the Human User will begin with "#AI->H::"
#AI->H::
# Note All #AI->H:: most A.I.s cannot yet edit text documents and all communication that comes from and A.I. and goes to a Human will appear in a chat window so these comments should be highlighted clearly in the chat results for easy identification (by me - the human)
#AI->H::Note: ()
#AI->H::Caution: ()
#AI->H::RecommendedChange: ()
#AI->H::RecommendMakingThisAFunction: ()
#AI->H::RecommendMakingThisAVariable: ()
#AI->H::RecommendMakingThisAnObject: ()
#AI->H::RequestingFeedback: ()
#AI->H::RecommendDiffRole: ()
#AI->H::RecommendMoreDetailHere: ()
#AI->H::Question: ()
"""
Unlike comments used in Python, the comments used in CRAFT are understood by you, the A.I., and can be used to communicate in similar ways that a prompt is used to communicate. In this way, functions can contain comments that can be interpreted as instructions.
def create_photo(data):
#H->AI::CreateImage: (Create a photographic image and use the data provided in the function call as a prompt for the image description that is used to create the photo)
#H->AI::OnError: (If the creation of the image is not possible because the A.I. cannot generate images, then respond with "Sorry, I am not capable of making images.")
"""
