UNPKG

claudes-office

Version:

CLI tool to initialize Claude's office in your project

124 lines (93 loc) 5.04 kB
# Initializing Claude's Office for a New Project This guide outlines the process for setting up Claude's Office structure for a new project, customizing the templates, and establishing effective working patterns. ## Step 1: Understand the Project Before setting up the office, review all available project documentation: 1. Read project specifications and requirements 2. Identify key technologies and frameworks 3. Understand the project's architecture and domain 4. Note any specific standards or patterns to follow 5. Identify main components or modules ## Step 2: Customize CLAUDE.md Update the CLAUDE.md file in the project root with project-specific information: 1. **Project Overview**: Add a brief description of the project and its components 2. **Environment**: Update with working directories, technologies, and key libraries 3. **Project Structure**: Add the expected structure of the codebase 4. **Development Standards**: Update with project-specific code style and quality expectations 5. **Commands**: Add common commands for running, testing, and linting 6. **Additional Guidelines**: Add any project-specific rules or guidelines ## Step 3: Configure the Office Directory The base office structure is already set up. You may need to: 1. Remove any template files that aren't needed 2. Create additional subdirectories for project-specific needs 3. Adapt the existing directory structure if needed ## Step 4: Create Role-Specific Guidance Identify the key roles needed for the project and create or customize role files in the `/roles` directory: 1. Keep general roles like `architect.md`, `dev_lead.md`, and `project_manager.md` 2. Create project-specific roles (e.g., `backend_developer.md`, `ai_specialist.md`) 3. Create domain expert roles (e.g., `finance_expert.md`, `healthcare_specialist.md`) Each role file should include: - **Role Description**: What the role entails - **Core Responsibilities**: Key tasks for this role - **Key Skills and Knowledge**: Expertise areas for this role - **Approach to Problems**: How to think in this role - **Communication Style**: How this role communicates - **Considerations and Trade-offs**: What this role prioritizes - **Tools and Methods**: Specific techniques for this role - **Key Principles**: Guiding principles for this role ## Step 5: Add Reference Materials Populate the `/references` directory with project-specific resources: (you can use your playwright or fetch tools for research or crawling) - Technical documentation and guides - Domain-specific knowledge - Format examples and patterns - API references - Architecture diagrams - Database schemas - Example data Organize references in subdirectories by category when there's a significant amount of material. ## Step 6: Set Up Project Management Files Update these key tracking files in the office root: 1. **project_status.md**: Configure for the project's phases and components 2. **todo.md**: Add initial tasks with appropriate priorities 3. **workplan.md**: Define project timeline, phases, and milestones 4. **office_map.md**: Update with any project-specific directory changes ## Step 7: Initialize Work Tracking 1. Update the session template if needed: ``` /worksessions/session_template.md ``` 2. Create the first work session file: ``` /worksessions/current.md ``` Include appropriate sections based on the project's needs. ## Step 8: Conduct First Work Session In the first work session: 1. Review all project materials thoroughly 2. Set up the initial project structure 3. Document key findings and decisions 4. Create a prioritized task list 5. Document any questions that need answers ## Step 9: Establish Maintenance Habits Make these practices part of your workflow: 1. Update project_status.md and todo.md after each significant change 2. Create new worksession files for each major work period 3. Move completed session files to the logs directory 4. Add new reference materials as you learn 5. Refine role guidance as the project evolves 6. Review and update the workplan regularly ## Step 10: Customize Templates as Needed As the project progresses, you may need to: 1. Refine the formats of tracking documents 2. Create additional template types for recurring documents 3. Adjust the level of detail in session logs 4. Create specialized subdirectories for complex areas 5. Add automation or scripts for common tasks ## Best Practices 1. **Consistent Naming**: Use consistent file naming conventions throughout 2. **Clear Structure**: Keep the directory organization intuitive 3. **Regular Updates**: Make office maintenance part of your routine 4. **Role Switching**: Explicitly adopt different roles for different tasks 5. **Reference First**: Check existing references before searching elsewhere 6. **Decision Logging**: Document important decisions and their rationale 7. **Active Prioritization**: Keep the todo.md list current and prioritized 8. **Contextual Continuity**: Ensure worksession files maintain context between sessions