Skip to content

Commit

Permalink
🚚 refactor: Reorganize file structure and rename utils
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaultyou committed Oct 21, 2024
1 parent 0ee0c8e commit 2ce2881
Show file tree
Hide file tree
Showing 42 changed files with 987 additions and 499 deletions.
31 changes: 10 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,8 @@ Welcome to the **Prompt Library**, a collection of categorized AI prompts for ea

## 📚 Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [🎯 Purpose & Features](#-purpose--features)
- [⚡ Quick Start](#-quick-start)
- [🛠️ How It Works](#-how-it-works)
- [🖥️ CLI Usage](#-cli-usage)
- [Interactive Menu](#interactive-menu)
- [List Prompts and Categories](#list-prompts-and-categories)
- [Sync Personal Library](#sync-personal-library)
- [Execute Prompts](#execute-prompts)
- [📂 Prompt Library Example](#-prompt-library-example)
- [🚀 Getting Started](#-getting-started)
- [🧩 Using Fragments](#-using-fragments)
- [⚙️ Metadata Customization](#-metadata-customization)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- START doctoc -->
<!-- END doctoc -->

## 🎯 Purpose & Features

Expand Down Expand Up @@ -128,10 +111,18 @@ prompt-library-cli execute --help
- [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimized git branch names based on project context and user requirements
- [Git Commit Message Agent](prompts/git_commit_message_agent/README.md) - Generates precise and informative git commit messages following Conventional Commits specification
- [Software Architect Visionary](prompts/software_architect_agent/README.md) - Analyzes user requirements and creates comprehensive software specification documents
- [GitHub Issue Creator](prompts/github_issue_creator_agent/README.md) - Creates comprehensive and actionable GitHub issues based on provided project information
- [Software Architect Specification Creator](prompts/software_architect_spec_creator/README.md) - Creates comprehensive software specification documents based on user requirements
- [Software Architect Code Reviewer](prompts/software_architect_code_reviewer/README.md) - Generates comprehensive pull requests with architectural analysis and optimization suggestions
- [Software Development Expert Agent](prompts/software_dev_expert_agent/README.md) - Provides expert, adaptive assistance across all aspects of the software development lifecycle.

</details>
<details>
<summary><strong>Content Creation</strong></summary>

- [Documentation Specialist Agent](prompts/documentation_specialist_agent/README.md) - Generates revolutionary software documentation using advanced AI techniques and industry best practices

</details>
<details>
<summary><strong>Healthcare</strong></summary>
Expand All @@ -150,9 +141,7 @@ prompt-library-cli execute --help
<summary><strong>Prompt Engineering</strong></summary>

- [AI Assistant Architect](prompts/ai_assistant_architect/README.md) - Conceptualizes innovative and feasible AI assistant designs for various domains
- [Advanced Documentation Agent](prompts/advanced_documentation_agent/README.md) - Generates revolutionary, next-generation software documentation using advanced AI techniques
- [Prompt Engineering God](prompts/prompt_engineering_agent/README.md) - Crafts divine-tier prompts to maximize AI potential while adhering to ethical standards
- [Software Engineering Architect Agent](prompts/software_engineering_architect/README.md) - Analyzes requirements and creates comprehensive software specification documents

</details>
<details>
Expand Down
62 changes: 0 additions & 62 deletions prompts/advanced_documentation_agent/metadata.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# Advanced Documentation Agent
# Documentation Specialist Agent

### ✏️ One-line Description

**Generates revolutionary, next-generation software documentation using advanced AI techniques**
**Generates revolutionary software documentation using advanced AI techniques and industry best practices**

### 📄 Description

This prompt creates an AI agent specialized in producing cutting-edge software documentation. It employs advanced techniques such as AI-powered content generation, interactive elements, and predictive analytics to create comprehensive, user-friendly, and innovative documentation across multiple formats.
This prompt creates a hyper-advanced AI documentation specialist capable of analyzing codebases and project requirements to produce state-of-the-art software documentation. It employs cutting-edge techniques such as AI-powered content generation, interactive examples, and adaptive documentation to set new industry standards for clarity and usability.

### 🔧 Variables

- `{{PROJECT_REQUIREMENTS}}` - Defines the specific documentation needs and goals for the project
- `{{EXISTING_DOCS}}` - Provides any existing documentation to be analyzed and improved upon
- `{{CODEBASE}}` - Contains the project's source code for analysis and documentation generation
- `{{SAFETY_GUIDELINES}}` - 🔧 **Optional** - Specifies any safety or ethical considerations to be followed
- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines specific behavioral traits for the AI agent
- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Allows users to specify their preferences for AI interaction
- `{{PROJECT_REQUIREMENTS}}` - Specifies the project-specific documentation requirements
- `{{EXISTING_DOCS}}` - Provides any existing documentation for analysis and improvement
- `{{CODEBASE}}` - Contains the codebase to be analyzed for documentation generation
- `{{SAFETY_GUIDELINES}}` - 🔧 **Optional** - Outlines safety considerations for documentation generation
- `{{AI_BEHAVIOR_ATTRIBUTES}}` - Defines specific AI behavior attributes for documentation creation
- `{{USER_BEHAVIOR_PREFERENCES}}` - 🔧 **Optional** - Specifies user preferences for documentation style and format
- `{{FORMATTING_GUIDELINES}}` - Provides specific formatting requirements for the documentation
- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired format for the generated documentation
- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Allows for additional instructions or context to be provided
- `{{OUTPUT_FORMAT}}` - 🔧 **Optional** - Specifies the desired output format for the generated documentation
- `{{EXTRA_GUIDELINES_OR_CONTEXT}}` - 🔧 **Optional** - Provides additional context or guidelines for documentation creation

### 🧩 Relevant Fragments

This prompt could potentially use the following fragments:
- [Behavior Attributes](/fragments/prompt_engineering/behavior_attributes.md) - Could be used into `{{AI_BEHAVIOR_ATTRIBUTES}}`
- [Formatting Guidelines](/fragments/prompt_engineering/formatting_guidelines.md) - Could be used into `{{FORMATTING_GUIDELINES}}`
- [Safety Guidelines](/fragments/prompt_engineering/safety_guidelines.md) - Could be used into `{{SAFETY_GUIDELINES}}`
- [Behavior Attributes](/fragments/prompt_engineering/behavior_attributes.md) - Could be used into `{{AI_BEHAVIOR_ATTRIBUTES}}`

### 📜 Prompt

Expand Down Expand Up @@ -243,15 +243,15 @@ Now, leveraging your advanced AI capabilities and adhering to the provided guide

### 🔖 Tags

- AI_documentation
- API_docs
- API_documentation
- user_guides
- developer_docs
- technical_writing
- software_engineering
- innovation
- AI_assisted_documentation

### 📚 Category

Primary category: prompt_engineering
Primary category: content_creation

Subcategories:

Expand Down
60 changes: 60 additions & 0 deletions prompts/documentation_specialist_agent/metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
content_hash: 604ea79d6796e71361a317c27cdcfcf2
description: >-
This prompt creates a hyper-advanced AI documentation specialist capable of
analyzing codebases and project requirements to produce state-of-the-art
software documentation. It employs cutting-edge techniques such as AI-powered
content generation, interactive examples, and adaptive documentation to set
new industry standards for clarity and usability.
directory: documentation_specialist_agent
fragments:
- category: prompt_engineering
name: behavior_attributes
variable: '{{AI_BEHAVIOR_ATTRIBUTES}}'
- category: prompt_engineering
name: formatting_guidelines
variable: '{{FORMATTING_GUIDELINES}}'
- category: prompt_engineering
name: safety_guidelines
variable: '{{SAFETY_GUIDELINES}}'
one_line_description: >-
Generates revolutionary software documentation using advanced AI techniques
and industry best practices
primary_category: content_creation
subcategories:
- technical_writing
- software_documentation
tags:
- API_documentation
- user_guides
- developer_docs
- technical_writing
- AI_assisted_documentation
title: Documentation Specialist Agent
variables:
- name: '{{PROJECT_REQUIREMENTS}}'
optional_for_user: false
role: Specifies the project-specific documentation requirements
- name: '{{EXISTING_DOCS}}'
optional_for_user: false
role: Provides any existing documentation for analysis and improvement
- name: '{{CODEBASE}}'
optional_for_user: false
role: Contains the codebase to be analyzed for documentation generation
- name: '{{SAFETY_GUIDELINES}}'
optional_for_user: true
role: Outlines safety considerations for documentation generation
- name: '{{AI_BEHAVIOR_ATTRIBUTES}}'
optional_for_user: false
role: Defines specific AI behavior attributes for documentation creation
- name: '{{USER_BEHAVIOR_PREFERENCES}}'
optional_for_user: true
role: Specifies user preferences for documentation style and format
- name: '{{FORMATTING_GUIDELINES}}'
optional_for_user: false
role: Provides specific formatting requirements for the documentation
- name: '{{OUTPUT_FORMAT}}'
optional_for_user: true
role: Specifies the desired output format for the generated documentation
- name: '{{EXTRA_GUIDELINES_OR_CONTEXT}}'
optional_for_user: true
role: Provides additional context or guidelines for documentation creation
Loading

0 comments on commit 2ce2881

Please sign in to comment.