Kubernetes MkDocs Documentation .cursorrules prompt file

Author: samzong

What you can build

Kubernetes Documentation Generator: An advanced tool that automates the creation of comprehensive Kubernetes documentation using the latest stable versions, best practices, and MkDocs. Users can input Kubernetes configurations, and the tool will generate structured user guides, tutorials, and API references.Cloud Native Documentation Service: An online service that provides tailored documentation solutions for cloud native projects. This service offers expert technical writing services, architecture diagramming, and implementation of MkDocs for streamlined and user-friendly documentation.Markdown-Based Documentation Platform: A website or app that assists technical writers in creating, structuring, and maintaining cloud native documentation using Markdown and MkDocs. The platform would include features for collaborative editing, version control with Git, and built-in style guide enforcement.Kubernetes Best Practices Repository: A curated repository offering Markdown documentation on Kubernetes best practices, containerization, and microservices architecture. This repository would include common task instructions, troubleshooting guides, and release notes as reference material for professionals.Interactive Kubernetes Tutorial Hub: An educational platform providing interactive, step-by-step learning modules on deploying and managing applications on Kubernetes. These modules would include code snippets, command-line examples, and practical scenarios to ensure hands-on learning.Technical Writer's Style Guide App: An application that helps technical writers develop and maintain a consistent style across documentation projects. It supplies guidelines tailored to cloud native and Kubernetes documentation, ensuring consistent terminology and formatting.SEO-Optimized Documentation Dashboard: A service that assists in the optimization of documentation for search engines using metadata, tags, and SEO-friendly page titles. This tool integrates with MkDocs to improve the discoverability of technical content online.Cloud Native Collaboration Platform: An app that facilitates collaboration between technical writers, developers, and cloud native experts in real-time. Features include documentation reviews, updates, and integration with version control systems like Git.Metadata Enhancement Tool for MkDocs: A plugin for MkDocs that optimizes metadata handling, improving navigation and search functionality in technical documentation. It aims to enhance user experience while browsing documentation sites.AI-Powered Documentation Assistant: A digital assistant designed to help technical writers draft, review, and update cloud native documentation. Using AI, it suggests corrections, fills content gaps, and offers additional context and explanations for complex concepts.

Benefits

Synopsis

Developers and technical writers can use this prompt to create comprehensive and efficient documentation for cloud-native technologies, Kubernetes projects, and documentation sites using Markdown and MkDocs.

Overview of .cursorrules prompt

The .cursorrules file outlines the guidelines and best practices for creating technical documentation related to cloud native technologies, specifically focusing on Kubernetes, Markdown, and MkDocs. It emphasizes producing clear, concise, and technically accurate content with a logical structure, consistent formatting, and comprehensive coverage of topics. The file provides detailed instructions for documenting cloud native concepts, Kubernetes components, and MkDocs usage. It highlights the importance of technical accuracy, usability, collaboration, and version control in the documentation process. Additionally, the file specifies the use of metadata for enhanced SEO and requires adherence to specific documentation standards, ensuring thorough, user-friendly, and up-to-date content.

.cursorrules Content

You are an expert Technical Writer with a deep understanding of cloud native technologies, Kubernetes, and technical documentation best practices. You excel at creating clear, concise, and user-friendly documentation using Markdown and MkDocs.You always use the latest stable versions of Kubernetes, cloud native tools, and MkDocs. You're familiar with the latest features, best practices, and trends in cloud native architecture, containerization, and orchestration.Documentation Style and Structure:Cloud Native and Kubernetes Expertise:MkDocs Usage:Content Creation:Technical Accuracy and Usability:Documentation Best Practices:Metadata and SEO:Collaboration and Version Control:Other Rules to follow:Don't be lazy, provide thorough and accurate documentation for all requested topics and features.