Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.5 Quick Start: Reference Material #130

Open
amsiotdeveloper opened this issue Jun 27, 2024 · 4 comments
Open

3.5 Quick Start: Reference Material #130

amsiotdeveloper opened this issue Jun 27, 2024 · 4 comments
Assignees

Comments

@amsiotdeveloper
Copy link
Collaborator

amsiotdeveloper commented Jun 27, 2024

NOTE: _This Subtask is linked to a larger Task List_ticket #120

Task Owner:

Who owns this task and will approve the final deliverables?
Lazar

Objectives & Goals:

1. How does this task relate to the value track(s)?

- All of the effort we put into improving our product lines should provide value to our customers.
- We need to be able to clearly articulate the value each improvement will provide in the following three value tracks:
    1. Development - 
    2. Deployment
    3. Production

This article helps users at all stages by providing links to suggested reading material and reference material

2. Create a short statement explaining the objectives and goals for this ticket.

The goal of this article is to:

  • start creating a list of suggested reading so a new user can refer to this article and easily find helpful content to get them started.
  • provide an introduction to other available accessories and hardware with a soft upsell.

Reference Material:

1. Provide hyperlinks for helpful and related information.

Please refer to outline:
https://docs.google.com/document/d/1h7JF9ceYgBxK7cVass_cCJOiFn6moJTYrZp7dWuJpKI/edit#heading=h.wfyhhst8qxhk

Deliverables or Desired Outcome:

1. What are the task owners expectations?

  • Articles should be succinct, and minimalist.
  • an outline of links with a brief description why this is suggested content to read
  • a list of links with a brief description introducing other accessories and hardware

2. What does the task owner require for a successful completion of the ticket?

i.e. sample code, drawings, documents etc.
  • a succinct article that follows our current style guide based on the original article
  • a new user should be able to find reading material to help the get started in different areas of their project development path
  • this article is intended to be a starting point and by no means do we expect at this stage to provide a comprehensive list. We can build on this list as time permits.
  • a new user should have a good overview of other accessors and hardware that is available for their project

Date Required By:

1. When is the scope required to be completed?

  • no date has been specified

2. Is this a hard date? Specify if the task is a dependency of another task or if it will impact a customer requirement.

@amsiotdeveloper amsiotdeveloper changed the title 3.5 Quick Start: Suggested Reading 3.5 Quick Start: Reference Material Jul 5, 2024
@remingtontr
Copy link
Collaborator

For each of the products listed I'll provide a brief description. Do we want to link to the old documentation for a detailed reference or will we be rewriting the old documentation?

@remingtontr
Copy link
Collaborator

Ready for initial review

@amsiotdeveloper
Copy link
Collaborator Author

@remingtontr this looks like an excellent improvement from the original table.
My only suggestion is every item is starting out with "Onion's ..."
There is nothing wrong with this but after reading the whole doc it does get a little repetitive so if you think it's worth changing it up little then give it a shot, otherwise let's proceed with PR.

@remingtontr
Copy link
Collaborator

Agreed. I'll revise slightly so it's not so repetitive.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Approved for Production
Development

No branches or pull requests

2 participants