Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Welcome to the FastDoc, This guide is for users who want to install FastDoc and set it up for their teams.

Step 1: Install Fastdoc on Your Jira Instance

  • Find FastDoc for Jira App on the Atlassian Marketplace: https://marketplace.atlassian.com/apps/1233783

  • Verify that you have admin access to your Jira instance where you want to install FastDoc.

  • Install the app to the desired Jira instance.

image-20240510-190103.png

Step 2: Accessing Fastdoc

Post-installation, Fastdoc is readily accessible from two places

  • Jira Issue View: You can find Fastdoc button to access the app interface from any Jira ticket.

  • Fastdoc App Home: Alternatively, Fastdoc is available via the app section in Jira, presenting a broader range of features.

Step 3: Creating a New Document

  • FastDoc Icon: In the Jira issue view, click on the FastDoc icon to initiate document creation.

  • Create Document Button: Alternatively, use the "Create Document" button within the Fastdoc app to start a new document.

Step 4: Document Creation Form

  • Form Fields:The form requests details such as tone, document type, and an optional goal.

    • From Jira Issue View: The issue key is pre-selected and cannot be changed.

    • From Fastdoc App: You can select the issue key from a dropdown. 

Step 5: Generating the Document

  • Click "Create" to commence document generation. The process typically takes 1-2 minutes.

  • Progress Tracking: The status will show as "Generating" and change to "Ready" once complete.

Step 6: Accessing and Editing the Document

  • View the generated document in the Fastdoc document preview and editor.

  • Editing features include basic text manipulation, copying, and document deletion.

Step 7: Enhancing Output Quality (Optional)

  • Improve document quality by adding company resources (URLs or documents) in FastDoc settings.

  • These resources provide contextual data to our AI, refining document generation.

Note: Only publicly accessible documents can be added. For eg a help center or knowledge base that’s open to public or your markteing website. If it’s a private space in confluence it will be be parsed.

An alternative can be to export in the .pdf or word file and upload it.

Note: While optional, this step significantly boosts the quality of output documents.

  • No labels