|
| 1 | +--- |
| 2 | +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.' |
| 3 | +applyTo: '**/*.{md,js,mjs,cjs,ts,tsx,jsx,py,json}' |
| 4 | +--- |
| 5 | + |
| 6 | +# Use Cliche Data in Documentation |
| 7 | + |
| 8 | +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 recognized placeholder data that cannot expose sensitive information. |
| 9 | + |
| 10 | +## Why This Matters |
| 11 | + |
| 12 | +A tool's source code and local configuration often contain real names, real email addresses, real organization 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: |
| 13 | + |
| 14 | +- Internal business names and contacts |
| 15 | +- Email addresses and domain names |
| 16 | +- Client or customer identifiers |
| 17 | +- Account names and credentials |
| 18 | +- Organization-specific terminology that reveals private operations |
| 19 | + |
| 20 | +## Core Rule |
| 21 | + |
| 22 | +> **If data came from a prompt, a local file, a script, a config, or a task — it does NOT go into documentation.** |
| 23 | +> |
| 24 | +> Documentation examples use only well-known, fictional, or obviously placeholder data. |
| 25 | +
|
| 26 | +## What Counts as Real Data |
| 27 | + |
| 28 | +Any value that originates from: |
| 29 | + |
| 30 | +- **Local configuration files** (e.g., `config.json`, `.env`, account modules) |
| 31 | +- **Scripts and task files** (e.g., batch scripts, shell scripts, task runners) |
| 32 | +- **Prompt context** (e.g., data the user supplies when asking an agent to build or update the tool) |
| 33 | +- **Map or filter files** (e.g., JSON mappings, data extraction rules) |
| 34 | +- **Git-ignored files** (e.g., files excluded from version control that contain environment-specific values) |
| 35 | + |
| 36 | +## Approved Placeholder Data for Documentation |
| 37 | + |
| 38 | +Use these generic, cliche substitutes in all documentation and examples: |
| 39 | + |
| 40 | +| Category | Approved Placeholder Examples | |
| 41 | +| --- | --- | |
| 42 | +| **People** | Jane Doe, John Smith, Alice, Bob | |
| 43 | +| **Email addresses** | `jane.doe@example.com`, `admin@example.org` | |
| 44 | +| **Organizations** | Acme Corp, Contoso, Northwind Traders | |
| 45 | +| **Domains** | `example.com`, `example.org`, `example.net` | |
| 46 | +| **Addresses** | 123 Main Street, Suite 100, Springfield | |
| 47 | +| **Phone numbers** | `(555) 123-4567` | |
| 48 | +| **Accounts / usernames** | `demo-user`, `test-account` | |
| 49 | +| **File paths** | `accounts/acme.mjs`, `config/reports.json` | |
| 50 | +| **Project names** | My Project, Sample App, Demo Tool | |
| 51 | + |
| 52 | +## How to Apply This Rule |
| 53 | + |
| 54 | +### When Adding a Feature |
| 55 | + |
| 56 | +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. |
| 57 | + |
| 58 | +**Real implementation file:** an account module configured for a specific business |
| 59 | + |
| 60 | +**Documentation example:** |
| 61 | + |
| 62 | +```javascript |
| 63 | +// accounts/acme.mjs — Example account configuration |
| 64 | +export default { |
| 65 | + name: 'Acme Corp', |
| 66 | + email: 'reports@example.com', |
| 67 | + folder: 'INBOX', |
| 68 | +}; |
| 69 | +``` |
| 70 | + |
| 71 | +### When Updating Configuration Docs |
| 72 | + |
| 73 | +If a config file references real domains, real paths, or real credentials, replace every real value with a placeholder before including it in documentation. |
| 74 | + |
| 75 | +**Documentation example:** |
| 76 | + |
| 77 | +```json |
| 78 | +{ |
| 79 | + "host": "imap.example.com", |
| 80 | + "user": "admin@example.com", |
| 81 | + "folder": "INBOX/Reports", |
| 82 | + "outputDir": "./downloads" |
| 83 | +} |
| 84 | +``` |
| 85 | + |
| 86 | +### When Writing Script Examples |
| 87 | + |
| 88 | +If a script automates a task for a specific organization, the documentation example must use a generic organization name and generic parameters. |
| 89 | + |
| 90 | +**Documentation example:** |
| 91 | + |
| 92 | +```batch |
| 93 | +@echo off |
| 94 | +REM Example: Run the extraction task for Acme Corp |
| 95 | +node extractEmail.mjs --account acme --task download |
| 96 | +``` |
| 97 | + |
| 98 | +## The Boundary Between Code and Docs |
| 99 | + |
| 100 | +| Context | Real Data Allowed? | |
| 101 | +| --- | --- | |
| 102 | +| Local scripts and config files used at runtime | Yes | |
| 103 | +| Git-ignored files with environment-specific values | Yes | |
| 104 | +| Prompt data provided to build or configure the tool | Yes (in code only) | |
| 105 | +| README.md, docs/ folder, and example templates | **No — use placeholders only** | |
| 106 | +| CHANGELOG.md entries | **No — describe changes generically** | |
| 107 | +| Code comments in committed source files | **No — keep generic** | |
| 108 | + |
| 109 | +## One Exception |
| 110 | + |
| 111 | +A word from real data may appear in documentation **only** if it is a common English word used in its ordinary sense and **not** in the context of an example. For instance, the word "development" is acceptable in a sentence like "This tool is under active development" even if it also appears in a real organization name. |
| 112 | + |
| 113 | +## Summary |
| 114 | + |
| 115 | +Documentation is public. Implementation data is private. Keep them separate. Every example in every doc file should pass a simple test: *could a stranger read this and learn nothing about the real users, clients, or organizations behind this tool?* If the answer is no, replace the data with cliche placeholders. |
0 commit comments