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

Propose conforming to ISO standards document format / structure #11

Open
doudulac opened this issue Jul 26, 2023 · 1 comment
Open

Propose conforming to ISO standards document format / structure #11

doudulac opened this issue Jul 26, 2023 · 1 comment

Comments

@doudulac
Copy link

doudulac commented Jul 26, 2023

If the ultimate goal is to propose WDI as an ANSI/ISO standard, I recommend starting now to structure the documentation accordingly. I don't think it's necessary to replace the markdown headings currently in use, and the formalism dictated by the standards document structure aren't very intuitive for a readme.md. But maybe we could think about adding the mandatory sections, or at the very least, think about which markdown section headers would map to them. What lead me to this comment was a lack of term definitions. The term "device", for example, is used quite often, and while we have an idea of what that is, it will need at least a definition, if not a newly defined, non-generic term. The following are the mandatory sections I could identify from the simple template provided by ISO.

  1. Scope
  2. Normative references
  3. Terms and definitions

The ' Introduction ', while not listed as mandatory, seems a good spot for Background and Purpose. Just some thoughts before we have to restructure and rewrite sections. Been there, done that. Not fun.

https://www.iso.org/iso-templates.html
Download the simple draft template for ISO standards (.doc)
http://www.iso.org/iso/model_document-rice_model.pdf

@jeredhdean
Copy link
Member

Agreed. As much as possible we should format for future use. Adding this as a #TODO

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

No branches or pull requests

2 participants