[New Best Practice Guide]: Product Website Content and Structure Practice/Guidance

Checked for duplicates

Yes - I've already checked

Describe the needs

Currently there is a nice trade study from SLIM on information hosting https://nasa-ammos.github.io/slim/docs/guides/documentation/documentation-hosts/ that references Docusaurus as one option. It would be good to have a Best Practice Guide that speaks to the minimal needs one level deeper and has a template for taking something like Docusaurus one level deeper.

At a high level I'd call out some potential core components to said best practice.

1. Docs - Audience: Product User, Purpose: Understand capabilities, configurations, design
2. API - Audience: Developer, Purpose: Understand programmatic interfaces (likely can be generated)
3. Blog - Audience: User Community, Purpose: Communication
4. Main Site - Page, Audience: General, Purpose: Branding and outreach

The best practice guide could map out these core components based on a survey or summary of publications that speak to this content. It could provide guidance to the content and high level structure of these components. Moreover, it could provide pratical guidance on how to tie to together other practices suggested through SLIM (e.g. where to provide links to you community, where your releases get announced, etc. ).

A parallel effort to this could be a Docusaurus template project that brings these pieces together and builds in this one level deeper guidance and implementation. The Aerie provides a good baseline for this . I suggest that we could use MMGIS as a test case to map into a similar structure.

Some Goals:

• Minimize maintenance of documentation
• Provided branding footprint and structure for software products
• Create a shared repository that provides a faster jumping of point for new open source software
• Provide a path for folks to map existing open source software sites into