Skip to content

Latest commit

 

History

History
62 lines (35 loc) · 2.11 KB

README.md

File metadata and controls

62 lines (35 loc) · 2.11 KB
Raw

Documentation Generator

The Documentation Generator is a Python script that utilizes OpenAI's GPT-3 API to generate documentation based on user input. This versatile tool allows you to quickly create various types of documents, from security policies and incident response plans to user manuals and technical guides.

Prerequisites

Before using the Documentation Generator, ensure you have the following prerequisites in place:

  • Python 3 installed on your system.
  • An OpenAI API key. You can obtain one by signing up on the OpenAI platform.

Getting Started

  1. Clone this repository to your local machine or download the documentation_generator.py script.

  2. Set your OpenAI API key as an environment variable:

    export OPENAI_API_KEY=your_api_key_here

  3. Run the script:

    python documentation_generator.py

  4. Follow the prompts to specify the type of document you want to create, provide specific details, and choose the desired format (Markdown or plain text).

  5. The script will generate the documentation and present it to you.

  6. You can choose to save the documentation as a Markdown file (with proper formatting) or plain text.

Usage

  • Specify the type of document you want to generate (e.g., Security Policy, User Manual).

  • Provide specific details and requirements for the document.

  • Choose the format for the document (Markdown or plain text).

  • Review the generated documentation and decide whether to save it.

Example

Here's an example of using the Documentation Generator:

  1. Run the script and specify "User Manual" as the document type.

  2. Provide details about the product or system you want to document, including features, usage instructions, and troubleshooting tips.

  3. Choose the Markdown format for the document.

  4. The script will generate a user manual in Markdown format with proper headings and formatting.

  5. You can choose to save it as "User_Manual.md".

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • This script uses OpenAI's GPT-3 API for natural language generation.