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

Add a how-to-write-a-spec guide #372

Open
DanielOaks opened this issue Feb 27, 2019 · 4 comments
Open

Add a how-to-write-a-spec guide #372

DanielOaks opened this issue Feb 27, 2019 · 4 comments
Labels

Comments

@DanielOaks
Copy link
Member

DanielOaks commented Feb 27, 2019

I'll be writing this up. It'll be something which actually lays out best practices and guidance for writing specs, and a nice companion to the example spec. Going through 'explain things close together rather than in different sections of the document', 'explain things in the simplest way', etc.

Possible language to recommend against:

Non-normative: Where possible, use 'fictitious' 'imaginary', or some other word when discussing examples, as this more easily explains what's meant to regular implementers.

suggestion from jw: "this section is non-normative and uses fictitious examples" as a recommendation.

@RyanSquared
Copy link
Contributor

RyanSquared commented Feb 27, 2019

07:50 LordRyan: I'm [in favor of keeping] non-normative just because it's commonly used language [in various specifications and projects]; even if you don't know English you see it often enough to know what it means.

Definitely would prefer it to "fictitious", but I'm not sure how our (as-is) non-normative section would be "imaginary" rather than it being nonstandardized yet common behavior. "This section is imaginary"?

@justjanne
Copy link
Contributor

Possible further recommendations include Sections 2.3 through 2.8 from the Michigan University Technical Writing Guide

@DanielOaks
Copy link
Member Author

Note to self: Provide general guidance at a reasonable, easily-readable level and link to external more complete/in-depth resources for people who want to go further with it.

@jwheare jwheare added the Meta label Apr 29, 2019
@RyanSquared
Copy link
Contributor

one thing i have noticed on the SASL 3.1 spec (which may change in the future when i get around to fixing up my PR) is that replies and errors were together in mixed order and this lead me to believe that one of the replies (908) was actually an error, when an error was also sent (904). so i would suggest having distinctly separate section between replies and errors to avoid mixups like these.

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

No branches or pull requests

4 participants