# One-Click Documentation

## One-Click Documentation

Welcome to the One-Click Documentation Unity package! This asset streamlines the documentation process for your Unity projects, enabling you to effortlessly generate and manage comprehensive documentation for your scripts with just a single click. Designed to save you time and reduce manual effort, One-Click Documentation leverages advanced AI technology to create accurate and detailed documentation directly from your code.

[Visit YourIndie.dev Website](https://yourindie.dev)

\
[Video Overview](https://youtu.be/MiU4jcRGTUk)

\
[Get it on the Unity Asset Store](https://assetstore.unity.com)

\
[Online Documentation](https://indie-4.gitbook.io/one-click-documentation/)

### Overview

Creating and maintaining up-to-date documentation is crucial but can be a cumbersome task, especially when juggling multiple projects. Manually writing documentation can consume valuable development time and lead to inconsistencies. One-Click Documentation simplifies this process by automating documentation creation using AI-powered insights, allowing you to focus more on your creative and coding tasks without getting bogged down by documentation.

### Key Features

* **Effortless Documentation Generation**: Select your scripts, and One-Click Documentation will instantly produce detailed and coherent documentation, saving you countless hours.
* **Automated Workflow**: Integrates seamlessly into your Unity project to automate repetitive documentation tasks, streamlining your workflow and minimizing manual overhead.
* **Easy Updates**: Keep your documentation current with ease. Automatically refresh and update documents to reflect the latest code changes.
* **Powered by GPT Models**: Utilize advanced AI to generate context-aware and insightful documentation, ensuring your docs are both accurate and easy to understand.
* **Customizable and User-Friendly**: Tailor the asset to fit your project's unique needs. Set custom folder paths and enjoy an intuitive interface that guides you through setup and usage.

### Installation

To install the One-Click Documentation package in your Unity project, follow these steps:

1. **Download and Import the Package**:
   * Download the package from the Unity Asset Store or your preferred source.
   * Import it into your Unity project via Unity’s Package Manager.
2. **Setup API Key (if applicable)**:
   * Set up an Open AI API key, and create a corresponding scriptable object in the Unity Editor. Follow the asset creation process in the relevant menu if needed.
3. **Define Folder Paths**:
   * Customize the folder paths for your scripts and documentation by setting these parameters in the DocumentationSettings ScriptableObject.

Setup OpenAI Key Demo

<https://app.storylane.io/share/xjvc0pwe5uzl>

### Usage

One-Click Documentation provides both Editor and runtime components for managing your documentation needs.

1. **Open Documentation Manager**:
   * Navigate to `Tools > Indie > Documentation Manager` in the Unity Editor to open the Documentation Manager window.
2. **Generate Documentation**:
   * Click the "Create All Documentation" button to create or update documentation for all scripts within the selected folder. Confirm the process to start generating documentation.
3. **Manage Documentation**:
   * Use the Editor to configure settings, view generated documents, and adjust parameters as needed.
4. **Update and Review**:
   * Easily refresh and review your documentation to ensure it remains accurate and up-to-date with code changes.

### Conclusion

One-Click Documentation revolutionizes how you handle documentation in Unity, offering a powerful solution that simplifies the creation and management of your project’s documentation. Whether you’re an indie developer or part of a larger team, this asset helps you maintain thorough and accurate documentation effortlessly, so you can focus on what you do best—developing and creating.
