Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- # Claude Code Style Guide: Bus Plan Project
- ## Project Context
- Creation of a complete “bus plan” (succession documentation) for the role of [your position]. The documentation must be accessible to anyone in case of emergencies.
- ---
- ## Core Principles
- ### 1. File Management
- - **Format**: Only Markdown files (.md) for maximum compatibility
- - **Structure**: An index file (README.md or INDEX.md) that links to categorized responsibility files
- - **Updates**: Always update both the index **and** the relevant content files when adding or modifying responsibilities
- - **Language**: All documentation must be written in [your native language]
- - **Location**: Project folder organized by category
- ---
- ### 2. Communication Style
- **Always ask questions** when details are unclear or missing:
- - Where are access credentials stored?
- - What are the specific procedures or workflows?
- - What is the priority level of this responsibility?
- - What dependencies exist between systems?
- - Who are the contact people for each area?
- - Is there existing documentation to consult?
- - Are there critical periods?
- **Confirm understanding** before creating or updating any files.
- **Suggest organization** if a responsibility could belong to multiple categories.
- ---
- ### 3. Content Organization
- #### Main Categories (adjustable as needed):
- **System Administration**
- - [Include projects that belong to this category]
- **Unmanaged Systems**
- - [Include projects that belong to this category]
- **Automations**
- - [Include projects that belong to this category]
- **Support and Maintenance**
- - [Include projects that belong to this category]
- **Project Management**
- - [Include projects that belong to this category]
- **Critical Contacts**
- - [Include areas that belong to this category]
- ---
- ### 4. Document Structure Template
- Each responsibility document should include:
- ```markdown
- # [Responsibility Name]
- ## Overview
- [Brief description of the responsibility and its importance]
- ## Priority Level
- - [ ] Critical (requires immediate attention if it fails)
- - [ ] High (important but can wait hours/days)
- - [ ] Medium (important for normal operations)
- - [ ] Low (can be delegated or postponed)
- ## Access and Credentials
- - **Credential location**: [Where to find credentials]
- - **Access type**: [Admin/User/Read-only]
- - **Users with access**: [Who else has access]
- - **Recovery process**: [How to regain access if lost]
- ## Routine Procedures
- ### Daily/Weekly Tasks
- [Regular tasks and their frequency]
- ### Monthly/Quarterly Tasks
- [Less frequent recurring tasks]
- ### Annual/Seasonal Tasks
- [Tasks performed at specific times of year]
- ## Emergency Procedures
- ### Scenario 1: [Type of emergency]
- [Specific steps to follow]
- ### Scenario 2: [Type of emergency]
- [Specific steps to follow]
- ## Dependencies
- ### Related Systems
- [Which systems depend on this one, or vice versa]
- ### Key People
- [Who should be notified or consulted]
- ### Automations
- [Related scripts or automated processes]
- ## Contacts
- ### Technical Support
- - **Name/Company**:
- - **Phone**:
- - **Email**:
- - **Support hours**:
- - **Notes**:
- ### Internal Contacts
- - **Name/Role**:
- - **Extension/Email**:
- - **Responsibility**:
- ## Additional Documentation
- [Links to manuals, guides, or official documentation]
- ## Change History
- [Record of significant system or procedure changes]
- ## Notes and Observations
- [Any other critical information, tips, warnings]
- ## Last Updated
- **Date**: [yyyy-MM-dd]
- **Updated by**: [Name]
- ```
- ---
- ### 5. Response Format
- When providing a new responsibility:
- 1. **I will ask clarifying questions** if needed
- 2. **I’ll suggest** the most suitable category
- 3. **I’ll create or update** the necessary files
- 4. **I’ll confirm** the updates made
- 5. **I’ll ask** if related information should be added
- 6. **I'll ask for clarification** if the procedure seems to have some inconsistency, inefficiency or flaw.
- When creating or updating files:
- - I’ll show the file path
- - Summarize what was added or changed
- - Ask if any related info is missing
- - Verify that all links in the index work
- ---
- ### 6. Quality Checks
- Before finalizing any update, verify that:
- - ✅ All links in the index work correctly
- - ✅ Naming conventions are consistent (lowercase, hyphens, language)
- - ✅ Dates are included for time-sensitive info
- - ✅ Missing critical info is clearly marked (credentials, contacts, procedures)
- - ✅ Priority levels are clearly indicated
- - ✅ No duplicated information between files
- - ✅ Information is current and accurate
- ---
- ### 7. File Naming Structure
- **Conventions:**
- - All lowercase
- - Use hyphens between words
- - Descriptive, concise names
- - Avoid special characters (except hyphens)
- **Examples:**
- - `database-structure.md`
- - `scripts-automatic-emails.md`
- ---
- ## Example Interaction
- **You:** “I need to document [name of task].”
- **Claude Code:**
- Perfect — I’ll need some details to document [tool] properly:
- 1. **Access**: Do you have super admin access, or are there account limitations?
- 2. **Credentials**: Where are the credentials stored? (password manager, documentation, etc.)
- 3. **Critical tasks**: What are the most critical or frequent tasks you perform in [tool]?
- - Internal development
- - Troubleshooting
- - Other
- 4. **Backup contacts**: Is there anyone else with access who can serve as a backup contact?
- 5. **Automations**: Are there any automated processes related to [tool] (scripts, integrations, etc.)?
- 6. **Support**: What’s the [tool] support contact (email, phone, portal)?
- 7. **Seasonal tasks**: Are there specific tasks done at the start/end of the year?
- Once you answer, I’ll create the file `[tool]-administration.md` and update the main index.
- ---
- ## Special Considerations
- ### Priority Marking
- - **Critical**: Directly impacts daily operations
- - **High**: Important but can wait a short time
- - **Medium**: Needed for normal operations
- - **Low**: Can be delegated or postponed
- ### Time-Sensitive Information
- - Clearly mark seasonal tasks
- - Include deadlines where relevant
- - Document high-demand periods
- ### Integration Points
- - Highlight where systems interact
- - Document critical dependencies
- - Explain data flow between systems
- ### Script Documentation
- For in-house tools, include:
- - **Purpose**: What the tool does
- - **Schedule**: When it runs
- - **Dependencies**: What docs, or systems it needs
- - **Location**: Where the code lives
- - **Maintenance**: What requires periodic updates
- - **Contacts**: Who is affected if it fails
- ### Security and Confidentiality
- - **NEVER** include passwords directly in documents
- - Reference where credentials are stored securely
- - Document who has access to what
- - Include access recovery procedures
- ---
- ## Project Kickoff
- To begin, I’ll create:
- 1. **INDEX.md** – The main file linking all categories
- 2. **Folder structure** (optional) – If you prefer organized subfolders
- 3. **Base template** – For documenting each new responsibility
- Then, we’ll populate the bus plan gradually as you recall each responsibility.
- ---
- ## Important Reminders
- - 🔒 **Security first**: Never include passwords in documents
- - 📅 **Keep it current**: Always include the “last updated” date
- - 🔗 **Working links**: Check that all index links work
- - 📝 **Clarity**: Write for someone unfamiliar with the systems
- - ⚠️ **Clear priorities**: Mark what’s critical and what can wait
- - 🤝 **Updated contacts**: Verify that contact info is up to date
- ---
- **Ready to get started?**
- I can create the initial index structure, and we’ll begin documenting each responsibility systematically.
Advertisement
Add Comment
Please, Sign In to add comment