Best Practices


Plan Content Development

Before you write any content, spend some time anticipating what tasks you need to perform and make sure you have the time and resources to achieve your goals.

The following steps work for both small and large projects:

  1. Design the site structure
  2. Inventory existing content
  3. Plan the conversion of existing content into articles
  4. Map the planned articles to your structure
  5. Identify required new articles
  6. Repurpose existing content into articles
  7. Write new articles
  8. Proofread and edit
  9. Publish

Discussion

The most important planning task is identifying the scope of your documentation efforts and understanding the needs of your audience.

Presidium is pre-configured with a set of standard sections that are commonly used in software documentation. You can use this framework when starting to scope your project.


© Copyright 2024 SPAN Digital

Generated on Jan 17, 2024