26 lines
1.8 KiB
Markdown
26 lines
1.8 KiB
Markdown
|
|
|||
|
|
---
|
|||
|
|
title: "Core Tasks"
|
|||
|
|
linkTitle: "Core Tasks"
|
|||
|
|
weight: 6
|
|||
|
|
date: 2017-01-05
|
|||
|
|
description: >
|
|||
|
|
What can your user do with your project?
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
{{% pageinfo %}}
|
|||
|
|
This is a placeholder page that shows you how to use this template site.
|
|||
|
|
{{% /pageinfo %}}
|
|||
|
|
|
|||
|
|
Think about your project’s features and use cases. Use these to choose your core tasks. Each granular use case (enable x, configure y) should have a corresponding tasks page or tasks page section. Users should be able to quickly refer to your core tasks when they need to find out how to do one specific thing, rather than having to look for the instructions in a bigger tutorial or example. Think of your tasks pages as a cookbook with different procedures your users can combine to create something more substantial.
|
|||
|
|
|
|||
|
|
You can give each task a page, or you can group related tasks together in a page, such as tasks related to a particular feature. As well as grouping related tasks in single pages, you can also group task pages in nested folders with an index page as an overview, as seen in this example site. Or if you have a small docset like the [Docsy User Guide](https://docsy.dev/docs/) with no Tutorials or Concepts pages, consider adding your feature-specific pages at the top level of your docs rather than in a Tasks section.
|
|||
|
|
|
|||
|
|
Each task should give the user
|
|||
|
|
|
|||
|
|
* The prerequisites for this task, if any (this can be specified at the top of a multi-task page if they're the same for all the page's tasks. "All these tasks assume that you understand....and that you have already....").
|
|||
|
|
* What this task accomplishes.
|
|||
|
|
* Instructions for the task. If it involves editing a file, running a command, or writing code, provide code-formatted example snippets to show the user what to do! If there are multiple steps, provide them as a numbered list.
|
|||
|
|
* If appropriate, links to related concept, tutorial, or example pages.
|
|||
|
|
|