About .cursorrules prompt file
What you can build
- Automated README Creation Tool: An AI-powered platform where users can input project details and receive a comprehensive, Markdown-format README that follows best practices and includes all necessary sections from the Holistika template.
- Holistika Knowledge Base Integration Software: A tool that scans for relevant terminology, concepts, and references from the Holistika knowledge base to incorporate automatically into project documentation, ensuring consistency and relevance.
- Table of Contents Generator: A web service that generates dynamic, clickable tables of contents by analyzing Markdown documents, ensuring all sections and subsections are properly linked and represented.
- Metadata Management Application: An application that captures and organizes both Documentation and Process Metadata for projects, automating the inclusion of comprehensive metadata sections in documentation.
- Project Management Addendum Planner: A digital planner that helps create comprehensive addendums by guiding users through Program and Product Management perspectives, Use Cases, and References, ensuring all aspects are thoroughly covered.
- Markdown Architecture Visualizer: A tool for creating and embedding high-level architecture diagrams into Markdown documents, enabling seamless integration of visual components within README files.
- SOP Documentation Generator: An application specifically for creating Standard Operating Procedures (SOPs) in line with Holistika standards, complete with thorough operating procedures and clear, actionable steps.
- Review and Quality Assurance Tool: A service that aids in the final review of documentation, ensuring clarity, completeness, and consistency with Holistika's standardized goals and practices, reflecting Susan Madeira's enthusiastic yet professional tone.
Benefits
Holistika Integration: Incorporates specific Holistika terminology and references, ensuring seamless alignment with the existing ecosystem and documentation practices.
Detailed Addendums: Provides structured sections on Program Management, Product Management, Use Cases, and References, offering comprehensive insights into different stakeholder perspectives.
Personality Infusion: Utilizes Susana Madeira's character to convey enthusiasm and professionalism, enhancing readability and engagement in the README.
Synopsis
Developers building internal documentation tools or platforms for Holistika would benefit by creating a comprehensive, well-structured README generator that integrates Holistika-specific information.
Overview of .cursorrules prompt
The provided .cursorrules file is designed to generate comprehensive and well-structured README files for projects and Standard Operating Procedures (SOPs) within the Holistika ecosystem. It specifies the role of the AI assistant, Susana Madeira, who is responsible for creating user-friendly documentation by leveraging the Holistika knowledge base. The output must be in Markdown format, with a properly formatted table of contents and specific sections, including Metadata, Description, Operating Procedures, Addendums, and License. The file outlines detailed instructions for creating various subsections, incorporating Holistika-specific information, and ensuring clarity and alignment with Holistika's standards. The README generation process involves multiple steps, including creating an initial draft, integrating Holistika terminology, expanding addendums, and conducting a final review.
