report-writing
Use this still to write reports.
When & Why to Use This Skill
This Claude skill automates the generation of structured Markdown reports with a focus on organized file management and collaborative review. It follows strict Standard Operating Procedures (SOPs) to ensure reports are correctly categorized, cross-referenced, and stored within specific directory structures (like Obsidian or Dropbox), making it an essential tool for technical documentation and incident analysis.
Use Cases
- Technical Incident Reporting: Automatically documenting system failures (e.g., Azkaban run failures) into specialized 'Failure Reports' directories for streamlined debugging and auditing.
- Structured Knowledge Management: Creating and maintaining a repository of linked Markdown documents within Obsidian, ensuring consistent naming conventions and relative path referencing between files.
- Interactive Document Review: Facilitating a collaborative editing process where users can highlight text and add comments that the agent reads and addresses in real-time before finalizing the file.
- Automated Project Documentation: Generating comprehensive reports for various software repositories while maintaining a standardized folder hierarchy and internal link structure for better navigability.
| name | report-writing |
|---|---|
| description | Use this still to write reports. |
This skill allows you to write Markdown reports.
Standard Operating Procedure
Reports are always written to a subfolder under /home/hdemers/Dropbox/Documents/Obsidian/Grubhub/Repositories/.
The subdirectory's name shall match the current repository.
If there are no current repository, STOP and ASK the user where to store the report.
If multiple reports are being written as part of a given session, you shall reference the other documents, when applicable, using the markdown notation [Link Text](relative path to the file).
If this is a failure report (e.g. Azkaban run failures), write the report under subdirectory Failure Reports, which is itself under this repo's name (see 2 above).
User can comment on the report by highlighting words and referencing a comment found at the end: ==highlighted text==[^1]
[^1] Comment on highlighted text.
If user mentions "comments added" or something to that effec, it means the user has added comments to the report. Read the file back and answer those comments live, do not modify the file until user says oo.