FAQ List
Welcome to the FAQ section for Documentation.new. Here, we address some of the most common questions from our users to help you get the most out of our platform.
1. What is Documentation.new?
Documentation.new is an AI-powered tool designed to help product and development teams quickly create structured documentation. You can generate drafts from website links, product descriptions, or upload files, then seamlessly integrate them into Archbee for further customization and deployment.
2. What file formats can I upload to Documentation.new?
You can upload the following file formats:
- Markdown (.md)
- Plain Text (.txt)
- DOCX (.docx)
- YAML/YML (.yaml/.yml)
- JSON (.json)
- ZIP
- max 10MB
These formats can include unfinished drafts, internal documents, or export files like tutorials and knowledge bases.
3. How does the AI generate documentation drafts?
Once you upload your file or provide a URL/description of your product or feature, the AI analyzes the content and generates a well-structured draft. It breaks the information into sections and adds headers, an introduction, and technical content based on the input.
4. Can I edit the documentation after it’s generated?
Yes! After the draft is generated, you can continue to refine the content by interacting with the AI in the chat panel. You can ask the AI to update specific sections, add new content, or modify existing text.
Alternatively, you can click "Edit and Deploy" to open the full Archbee editor, where you can further customize your documentation, including adding media, changing formatting, and rearranging sections as needed.
5. What if the AI doesn’t generate the documentation as expected?
If the generated documentation doesn’t meet your needs, try these tips:
- Provide a more detailed description or clearer product page.
- Ensure the links or descriptions you provide are specific and relevant.
- Re-generate the draft for a potentially better outcome.
6. How do I publish my documentation?
Once you’re happy with your documentation, simply click the "Publish" button in Archbee. You can set the visibility to public, team-only, or private, and share the documentation via email, Slack, or embed it on your website.
7. What is the file size limit for uploads?
The file size limit for each uploaded document is 10MB. If your file exceeds this size, try compressing it or breaking it into smaller parts.
8. Can I use my own domain for the documentation portal?
Yes! You can set up a custom domain for your documentation. Go to Settings > Custom Domain in Archbee to configure this, and follow the DNS instructions provided.
9. Is Documentation.new free to use?
You can begin using Documentation New for free, which includes a certain amount of usage. When you need more capacity or advanced features, it's easy to upgrade. Just import all your current documentation into Archbee. If you don't have an Archbee account yet, you'll automatically receive a 14-day free trial of our various subscription levels. This trial lets you explore which plan best suits your team. For complete information on our subscription options and pricing, please visit:www.archbee.com/pricing.
10. How can I get help if I encounter issues?
If you need assistance, feel free to reach out to our support team by sending your question to [email protected].
11. Where can I see more example documentation portals?
Curious about how you can customize your documentation portal? Check out more example portals here: https://www.archbee.com/portals.
12. Can I add images, videos, and other media to my documentation?
Currently, in Documentation.new, you cannot directly add images, videos, or other media types. However, once your documentation draft is generated and imported into Archbee, you can fully customize your content.
In Archbee, you can:
- Add images, GIFs, diagrams, and other media files.
- Embed videos from platforms like YouTube or Vimeo.
- Use the code editor to insert code blocks and technical content.
For a fully branded and interactive experience, head to Archbee’s full editor to enhance your documentation with rich media and other customizable elements.º
13. How do I manage permissions and team collaboration?
Documentation.new integrates seamlessly with Archbee’s team collaboration features:
- Roles: You can assign users different roles such as Viewer, Editor, or Admin to control access.
- Version Control: Keep track of changes with Archbee’s version control and see who made updates to specific documents.
- Comments: Collaborate in real time using inline comments for feedback and suggestions.
14. Can I migrate existing documentation from other platforms?
Yes, you can easily migrate your existing documentation from platforms like Notion or Confluence. To do this:
- Go to Workspace Settings > Migrations.
- Upload your export file (Markdown, HTML, or CSV).
- Preview and clean up any formatting issues in your Archbee workspace.
15. What happens if I encounter a bug or technical issue?
If you experience a technical issue:
- Check the Help Center for troubleshooting steps.
- Report the bug directly to our Support Team so we can assist you.
- Include any relevant details (screenshots, error messages, etc.) to help us diagnose the issue faster.
If you have any other questions or need additional support, don't hesitate to reach out to us. We're here to help!