Documentation Task Creation

Guide to creating TTPs for documentation tasks

Windows
MacOS
Linux
  1. In TestTrack Pro, click the Add button.

  2. Enter a Summary for the new task. These should use one of the following prefixes:

    Prefix

    Use

    Engine Documentation:

    Create or update documentation relating to an engine system

    Editor Documentation:

    Create or update documentation for editor tools

    Engine Documentation Review:

    Review existing documentation relating to an engine system

    Editor Documentation Review:

    Review existing documentation for editor tools

    UE4: DOCTOOL:

    Bug fixes or feature requests for documentation tools, including UnrealDocTool, EpicMarkdownMode VS extension, localization tools, etc.

  3. Select the appropriate Type for the task. This will generally be one of:

    • Incorrect Functionality

    • Feature Request

  4. Choose UnrealEngine4 as the Product.

  5. Select the appropriate Department:

    Department

    Task Type

    Code

    Documentation tool coding task

    Docs

    Documentation creation or update task

  6. Choose All as the Platform.

  7. Select the appropriate Priority:

    Priority

    Uses

    0

    Documentation tool bugs that prevent publishing the documentation

    1

    Documentation tool bugs that are not blocking work

    2

    Reserved for current tasks assigned to users

    3

    Documentation creation, updates, and reviews that are high priority; Documentation tool features requests

    4

    Documentation creation, updates, and reviews

    5

    Documentation tool wish list items

    6

    Documentation tool ideas to investigate

  8. Select the appropriate Component: usually Documentation or Editor, though this may vary.

  9. In the Detail tab (click the Detail tab), enter a detailed Description of the task. Provide as much info as possible, including who to contact if more info is needed and to whom, if anyone, to assign the task for review when completed.

  10. In the Attachment tab (click the Attachments tab) of the Detail tab, attach any files needed to complete the task.

    • Click the Attach... button

    • Navigate to the file(s) to attach

  11. Assign the task to the user who will complete the task:

    The Workflow Events toolbar (View > Toolbars > Workflow Events) contains quick access to the Assign function so you can assign tasks to users before submitting them.

    Task

    User

    Documentation tool tasks

    Jaroslaw Palczinski

    General documentation tasks - backlog

    Engine Documentation

    Specific documentation tasks

    Assign to user to complete task

  12. Click the Add button to save the task.

  13. Close the window or continue adding new tasks.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback