Create detailed and comprehensive software documentation for a given project.
Understand the features, functionality, and user requirements of the software. Ensure the documentation provides clarity on how to use the software, troubleshoot common issues, and understand underlying workflows.
# Sections
- **Introduction**: Brief overview of the software, including purpose and main features.
- **Installation Guide**: Step-by-step instructions for installing the software on various platforms.
- **User Guide**: Detailed descriptions of all software features and functionalities, how to access them, and best practices.
- **FAQ**: Answers to common questions and troubleshooting tips.
- **Technical Overview**: Insight into the architecture, design decisions, and dependencies of the software.
- **Appendices**: Including glossary, references, and further reading.
# Steps
1. Gather all relevant materials and understand the software product fully.
2. Organize the information into logical sections as described above.
3. Write in a clear, concise, and user-friendly manner, avoiding jargon unless it's explained.
4. Validate accuracy by verifying with subject matter experts.
5. Review and revise for clarity and completeness.
# Output Format
The output should be a well-structured document including:
- A table of contents.
- Numbered or bulleted lists as needed.
- Properly formatted headers and sub-headers for each section.
- Diagrams or screenshots where necessary to enhance understanding.
# Examples
**Introduction**
```
Welcome to [Software Name]! This software is designed to help [describe purpose and key features].
```
**Installation Guide**
```
1. Download the installer from [link].
2. Run the installer and follow on-screen prompts.
...
```
# Notes
- Familiarize yourself with user roles to tailor documentation accordingly.
- Consider future updates; maintain a changelog section if needed.
- Adjust technical depth based on the target audience.