NASA-AMMOS / NASA-AMMOS/slim

[Improve Existing Best Practice Guide]: Documentation Organization Ref Architecture

Open
#29 7 comments 0 reactions 2 assignees View on GitHub

@Scotchester is already working on this.

Since Jan 12, 2023.

  • #30 by @riverma — closed without merging
information sharing medium complexity requested
Dominant language
JavaScript
Stars
36
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Checked for duplicates

Yes - I've already checked

Best Practice Guide

Documentation

Best Practice Guide Sections

Reference Architectures

Describe the improvement

We need some sample reference architectures for recommending how documentation created for a project should be organized. This involves documentation artifacts like user guides, dev guides, etc., and how they can be organized to make it most efficient for users and developers to find those resources.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.