Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@

This file provides guidance to Claude Code (claude.ai/code) when creating GitHub issues.

You are an expert technical communicator who specializes in two key areas:

1. Creating precise GitHub issues that follow engineering best practices with clear acceptance criteria, technical requirements, and implementation details appropriate for experienced developers.
2. Drafting professional business documents (statements of work, proposals, etc.) for a software development consulting company that effectively communicate technical scope, deliverables, and value to both technical and non-technical stakeholders.

For all content, prioritize clarity, specificity, and actionable details while maintaining a direct, professional tone.

## Repository Structure
- The current folder is the special GitHub `.github` repository containing GitHub issue templates and possibly other GitHub-related files for the whole organization.
- The current folder contains hidden directories starting with `.` (like `.github/`)
- The current folder contains a hidden directory `.github/`.
- When searching for files, always include hidden files and directories
- Issue templates are maintained in YAML format in `.github/ISSUE_TEMPLATE/`
- GitHub issue templates are maintained in YAML format in `.github/ISSUE_TEMPLATE/`
- Professional business document templates are in in the folder `docs-templates`

## GitHub Issue Standards
- When creating GitHub issues for any SixFeetUp repository, use the templates from THIS repository (dot-github)
Expand All @@ -21,14 +29,18 @@ This file provides guidance to Claude Code (claude.ai/code) when creating GitHub
- Include emoji in issue titles (like 🐞, ✨, 🌵, 🛠️) matching the template emoji
- Use the GitHub CLI (`gh`) to create issues directly without opening in the browser
- Format the issue body according to the template's structure and fields
- If a transcript was used to create the issue, reference the transcript file in the issue description

## GitHub issue creation
- When creating issues with GitHub CLI, use `--repo` to specify the repository and omit the `--web` flag to create the issue completely via CLI
- NEVER guess the repo name. If it's not provided, then ask for it before trying to create the issue.
- Open the issue in my web browser after you created it using `gh issue view --web`

## GitHub description rules
## GitHub issue description rules
- DO NOT ESCAPE special characters except `"`

## Professional Business Document Standards
- When creating professional business documents for any SixFeetUp repository, use the templates from THIS repository (dot-github)

## Commands
- No specific build/lint/test commands for this repository
113 changes: 113 additions & 0 deletions docs-templates/project-handoff.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# [Project Name] - Project Handoff Document

## Executive Summary

This document provides a comprehensive handoff of the [Project Name] project completed by SixFeetUp. It contains essential information for maintaining, operating, and expanding the delivered solution to ensure smooth transition of project ownership to [Client Name].

## Project Scope Recap

**Original Objectives:**
[Brief summary of the main goals and objectives outlined in the original SOW]

**What Was In Scope:**
- [Key deliverable or feature area]
- [Key deliverable or feature area]
- [Key deliverable or feature area]
- [Additional scope items as needed]

**What Was Delivered:**
- ✅ [Completed deliverable with brief description]
- ✅ [Completed deliverable with brief description]
- ✅ [Completed deliverable with brief description]
- ✅ [Additional completed items as needed]

## Access Management & Responsibilities

| System/Service | Contact Person | Department | Responsibilities |
|---|---|---|---|
| [System Name] | [Name, Email] | [Department] | [What they manage/access they have] |
| [System Name] | [Name, Email] | [Department] | [What they manage/access they have] |
| [System Name] | [Name, Email] | [Department] | [What they manage/access they have] |

## Documentation & Resources

**Technical Documentation:**
- **Code Repository:** [URL and access instructions]
- **API Documentation:** [Location and access method]
- **Deployment Guide:** [Location of deployment documentation]
- **Architecture Diagrams:** [Location of technical diagrams]

**User Documentation:**
- **User Manual:** [Location and access method]
- **Training Materials:** [Location of any training resources]
- **FAQ/Troubleshooting:** [Location of support documentation]

## Recommendations for Ongoing Success

### Immediate Actions (Next 30 Days)
- [ ] [Specific action item with owner]
- [ ] [Specific action item with owner]
- [ ] [Specific action item with owner]

### Medium-Term Improvements (3-6 Months)
- **[Recommendation Category]:** [Detailed recommendation with business justification]
- **[Recommendation Category]:** [Detailed recommendation with business justification]
- **[Recommendation Category]:** [Detailed recommendation with business justification]

### Long-Term Strategic Considerations
- **[Strategic Area]:** [Recommendation with timeline and potential impact]
- **[Strategic Area]:** [Recommendation with timeline and potential impact]

## Support & Maintenance

### Getting Help from SixFeetUp

**For Technical Issues:**
- **Email:** [support email]
- **Response Time:** [SLA for response]
- **Scope:** [What types of issues are covered]

**For Enhancements or New Features:**
- **Contact:** [business development contact]
- **Process:** [How to initiate new work discussions]

**Emergency Support:**
- **Contact:** [emergency contact information]
- **Availability:** [Emergency support hours/coverage]

### Self-Service Resources
- **Knowledge Base:** [URL to documentation or wiki]
- **Community Forum:** [If applicable]
- **Training Resources:** [Links to relevant training materials]

## Next Steps & Follow-Up

**Immediate Follow-Up:**
- SixFeetUp will schedule a follow-up call in **3 months** ([specific date]) to:
- Review system performance and stability
- Address any questions or concerns
- Discuss potential optimizations or enhancements
- Ensure the handoff has been successful

**Preparation for Follow-Up:**
- Please prepare a summary of any issues encountered
- Document any questions about system operation or maintenance
- Consider any new requirements or enhancement requests

---

## Contact Information

**SixFeetUp Project Team:**
- **Project Manager:** [Name, Email, Phone]
- **Technical Lead:** [Name, Email]
- **Account Manager:** [Name, Email, Phone]

**Document Information:**
- **Created:** [Date]
- **Version:** 1.0
- **Last Updated:** [Date]

---

*This document represents the completion of professional services provided by SixFeetUp. For questions about this handoff or future collaboration opportunities, please contact [primary contact information].*
46 changes: 46 additions & 0 deletions docs-templates/statement-of-work_multi-phases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# [Project Name]

## Executive Summary

This Statement of Work outlines the proposed [brief project description]. The project will be delivered in [number] phases, each building upon the previous to [high-level benefits and outcomes].

## Background

[Provide context about the current state, challenges, and the need for this project. Include information about existing systems or processes if applicable.]

## Phase [Number]: [Phase Name]

**Objective:** [Concise description of what this phase aims to accomplish and the value it delivers to stakeholders]

**Key Deliverables:**

1. [Deliverable Name] - Estimated effort: [XX pts]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]

2. [Deliverable Name] - Estimated effort: [XX pts]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]

3. [Deliverable Name] - Estimated effort: [XX pts]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]

## Phase [Number]: [Phase Name]

**Objective:** [Concise description of what this phase aims to accomplish and the value it delivers to stakeholders]

**Key Deliverables:**

1. [Deliverable Name]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]

2. [Deliverable Name]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]
30 changes: 30 additions & 0 deletions docs-templates/statement-of-work_single-phase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# [Project Name]

## Executive Summary

This Statement of Work outlines the proposed [brief project description]. The project will be delivered in [number] phases, each building upon the previous to [high-level benefits and outcomes].

## Background

[Provide context about the current state, challenges, and the need for this project. Include information about existing systems or processes if applicable.]

## Scope

**Objective:** [Concise description of what this phase aims to accomplish and the value it delivers to stakeholders]

**Key Deliverables:**

1. [Deliverable Name] - Estimated effort: [XX pts]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]

2. [Deliverable Name] - Estimated effort: [XX pts]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]

3. [Deliverable Name] - Estimated effort: [XX pts]
- [Specific component or feature]
- [Specific component or feature]
- [Expected outcomes or benefits]