Maximizing the Quality of Your FastDoc Documents

Owned by FastDoc
Aug 14, 2024
2 min read

At FastDoc, we understand how important it is for your generated documents to be as accurate and detailed as possible. To help you get the best results, we recommend considering the following key factors during your setup and document generation process.

1. Provide Detailed and Specific Input Data

The foundation of any high-quality document starts with the data you input. FastDoc relies heavily on the details provided in your Jira tickets to generate accurate documents. Here are some tips to enhance your input:

  • Ticket Details: Ensure that your Jira tickets contain detailed and descriptive titles, descriptions, and comments. The more specific the information, the better the output.

  • Subtasks: If your workflow involves complex processes, consider breaking them down into subtasks. This can help FastDoc capture the nuances of your project more effectively. (Note: Subtasks with the status "Withdrawn" are automatically excluded from the document generation process.)

  • Multiple Issues: You can select multiple Jira issues, use JQL/Filters, or leverage Project Release options to add more context based on your needs. This is especially useful for projects with interconnected tasks or overarching goals.

2. Set Clear and Relevant Document Generation Goals

When generating or regenerating documents, the goals you set play a crucial role in determining the final output. To ensure FastDoc produces documents that align with your expectations:

  • Define Your Goal: Clearly specify what you want the document to achieve. For example, if you need the document to focus on certain technologies or specific business rules, make sure to include this in your goal.

  • Refine As Needed: If the initial document doesn’t meet your expectations, consider adjusting the goal and regenerating the document. This iterative process can help refine the output to better suit your needs.

3. Add Context in the Resource Hub

The Resource Hub is a powerful tool within FastDoc that allows you to add additional context to your documents. This is particularly useful for capturing the unique aspects of your workflow that may not be fully covered by Jira tickets alone.

  • Supplementary Information: Include specific terminology, detailed descriptions of business processes, or any other relevant information in the Resource Hub. This added context can significantly improve the accuracy and relevance of your generated documents.

  • Nuances and Workflow Details: If there are particular nuances in your workflow or business rules, make sure to document these in the Resource Hub. FastDoc will incorporate this information into the final output, providing a more tailored document.

Conclusion

By focusing on detailed input data, clear goal setting, and adding supplementary context, you can greatly enhance the quality of the documents generated by FastDoc. These best practices will help ensure that the output is not only accurate but also aligned with your specific requirements.

If you need any assistance in setting up these factors or have any questions, feel free to reach out to our support team. We're here to help you make the most of FastDoc!