Use Cliche Data in Docs.instructions
--- description: 'Ensure documentation and examples use only generic, cliche placeholder data — never real or sensitive data sourced from local scripts, configuration, task files, or prompt context.' applyTo: '**/*.{md,js,mjs,cjs,ts,tsx,jsx,py,json}' --- # Use Cliche Data in Documentation When updating or writing documentation for a tool, **never include real data** that was provided in prompts, local configuration, scripts, task files, or any other implementation-specific source. Documentation must use only generic, commonly recognised placeholder data that cannot expose sensitive information. ## Why This Matters A tool's source code and local configuration often contain real names, real email addresses, real organisation details, and real domain names. These values are necessary for the tool to function, but they have **no place in public-facing documentation**. Leaking real data into docs can expose: - Internal business names and contacts - Email addresses and domain names - Client or customer identifiers - Account names and credentials - Organization-specific terminology that reveals private operations ## Core Rule > **If data came from a prompt, a local file, a script, a config, or a task — it does NOT go into documentation.** > > Documentation examples use only well-known, fictional, or obviously placeholder data. ## What Counts as Real Data Any value that originates from: - **Local configuration files** (e.g., `config.json`, `.env`, account modules) - **Scripts and task files** (e.g., batch scripts, shell scripts, task runners) - **Prompt context** (e.g., data the user supplies when asking an agent to build or update the tool) - **Map or filter files** (e.g., JSON mappings, data extraction rules) - **Git-ignored files** (e.g., files excluded from version control that contain environment-specific values) ## Approved Placeholder Data for Documentation Use these generic, cliche substitutes in all documentation and examples: | Category | Approved Placeholder Examples | | --- | --- | | **People** | Jane Doe, John Smith, Alice, Bob | | **Email addresses** | `jane.doe@example.com`, `admin@example.org` | | **Organizations** | Acme Corp, Contoso, Northwind Traders | | **Domains** | `example.com`, `example.org`, `example.net` | | **Addresses** | 123 Main Street, Suite 100, Springfield | | **Phone numbers** | `(555) 123-4567` | | **Accounts / usernames** | `demo-user`, `test-account` | | **File paths** | `accounts/acme.mjs`, `config/reports.json` | | **Project names** | My Project, Sample App, Demo Tool | ## How to Apply This Rule ### When Adding a Feature If you add a feature using real account data (e.g., a script named after a real client), document the feature using a fictional account name instead. **Real implementation file:** an account module configured for a specific business **Documentation example:**
fill the variables
This prompt has 1 variable. Pro fills them into a ready-to-paste prompt for you — no manual find-and-replace.
{md,js,mjs,cjs,ts,tsx,jsx,py,json}
Unlock with Pro →when to use it
Community prompt sourced from the open-source GitHub repo MarieLynneBlock/arcanum-artifex (no explicit license). A "Use Cliche Data in Docs.instructions" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
productivitycommunitydeveloper
source
MarieLynneBlock/arcanum-artifex · no explicit license
more in Productivity
Productivity✓ tested
Summarize a doc into decisions & actions
chief of staff who extracts what to DO, not just what was said
Productivity✓ tested
Draft a reply to a hard email
calm, direct communicator who de-escalates without caving
Productivity✓ tested
Turn a brain-dump into a weekly plan
planning coach who protects your focus, not just your calendar