Skip to content
Snippets Groups Projects
Select Git revision
  • e538174edb4f57e37ff8f6f74aac34195e386310
  • main default protected
  • Kelvinrr-patch-5
  • Kelvinrr-patch-4
  • Kelvinrr-patch-3
  • update_release_doc
  • Kelvinrr-patch-2
  • Kelvinrr-patch-1
  • spice_docs
  • ale_testing
  • changelog_docs
  • 1.0.1
  • 1.0.0
13 results

how-to-guides

user avatar
Sanders, Austin Ray authored
e538174e
History

How-To Guides

How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as pre-emptive StackOverflow-like problems.

For Readers

Use the table of contents on the left to start browsing guides.

For Authors

Before you start writing a new How-To guide. Make sure what you are writing belongs here. These are similar to getting-started guides, in that they explain to users how to perform some valuable tasks with the software, but distinct in that they:

  1. Solve practical problems for more experienced users
  2. Offer more ambiguous starting points; they should be reusable in many different contexts
  3. Can be much shorter than getting-started docs.

??? Info Examples * How-to: generate an ISD via loads with specific kernels * How-to: get GEOJSON from ISIS footprints * Cookbook of common operations in a library