0003.pdf (37235B)
1 %PDF-1.1 2 1 0 obj 3 << 4 /CreationDate (D:20210927172701) 5 /Producer (text2pdf v1.1 (\251 Phil Smith, 1996)) 6 /Title (0003 - Specification Style Guide) 7 >> 8 endobj 9 2 0 obj 10 << 11 /Type /Catalog 12 /Pages 3 0 R 13 >> 14 endobj 15 4 0 obj 16 << 17 /Type /Font 18 /Subtype /Type1 19 /Name /F1 20 /BaseFont /Courier 21 >> 22 endobj 23 5 0 obj 24 << 25 /Font << /F1 4 0 R >> 26 /ProcSet [ /PDF /Text ] 27 >> 28 endobj 29 6 0 obj 30 << 31 /Type /Page 32 /Parent 3 0 R 33 /Resources 5 0 R 34 /Contents 7 0 R 35 >> 36 endobj 37 7 0 obj 38 << 39 /Length 8 0 R 40 >> 41 stream 42 BT 43 /F1 10 Tf 44 1 0 0 1 50 802 Tm 45 12 TL 46 (Specification: 0003 R. Bron)' 47 (Obsoletes: 0000 June 2020)' 48 ()' 49 ()' 50 ( Specification Style Guide)' 51 ()' 52 (Abstract)' 53 ()' 54 ( This document describes the fundamental and unique style conventions and)' 55 ( editorial policies currently in use for the Specification Series. It offers)' 56 ( guidance regarding the style and structure of a Specification.)' 57 ()' 58 ()' 59 ()' 60 ()' 61 ()' 62 ()' 63 ()' 64 ()' 65 ()' 66 ()' 67 ()' 68 ()' 69 ()' 70 ()' 71 ()' 72 ()' 73 ()' 74 ()' 75 ()' 76 ()' 77 ()' 78 ()' 79 ()' 80 ()' 81 ()' 82 ()' 83 ()' 84 ()' 85 ()' 86 ()' 87 ()' 88 ()' 89 ()' 90 ()' 91 ()' 92 ()' 93 ()' 94 ()' 95 ()' 96 ()' 97 ()' 98 ()' 99 ()' 100 (Copyright Notice)' 101 ()' 102 ( This document is licensed under a)' 103 ( Creative Commons Attribution 4.0 International License)' 104 ()' 105 ( You should have received a copy of the license along with this work. If not,)' 106 ( see <http://creativecommons.org/licenses/by/4.0/>)' 107 ()' 108 (Bron [Page 1])' 109 ET 110 endstream 111 endobj 112 8 0 obj 113 1052 114 endobj 115 9 0 obj 116 << 117 /Type /Page 118 /Parent 3 0 R 119 /Resources 5 0 R 120 /Contents 10 0 R 121 >> 122 endobj 123 10 0 obj 124 << 125 /Length 11 0 R 126 >> 127 stream 128 BT 129 /F1 10 Tf 130 1 0 0 1 50 802 Tm 131 12 TL 132 (SD0003 Specification Style Guide June 2020)' 133 ()' 134 (Table of Contents)' 135 ()' 136 ( 1. Introduction ........................................................... 3)' 137 ( 2. Key Words .............................................................. 3)' 138 ( 2.1. MUST .............................................................. 3)' 139 ( 2.2. MUST NOT .......................................................... 3)' 140 ( 2.3. SHOULD ............................................................ 3)' 141 ( 2.4. SHOULD NOT ........................................................ 3)' 142 ( 2.5. MAY ............................................................... 4)' 143 ( 2.6. Guidance in the use of these Imperatives .......................... 4)' 144 ( 2.7. Security Considerations ........................................... 4)' 145 ( 3. Specification Syle Conventions ......................................... 5)' 146 ( 3.1. Language .......................................................... 5)' 147 ( 3.2. Punctuation ....................................................... 5)' 148 ( 3.3. DNS Names and URIs ................................................ 5)' 149 ( 3.4. Capitalization .................................................... 5)' 150 ( 3.5. Citations ......................................................... 6)' 151 ( 3.6. Abbreviation Rules ................................................ 6)' 152 ( 4. Structure of a Specification Document .................................. 7)' 153 ( 4.1. First-Page header ................................................. 7)' 154 ( 4.1.1. Author/Editor ................................................ 8)' 155 ( 4.1.2. Organization ................................................. 8)' 156 ( 4.1.3. Updates and Obsoletes ........................................ 8)' 157 ( 4.2. Full Title ........................................................ 9)' 158 ( 4.3. Abstract Section .................................................. 9)' 159 ( 4.4. Table of Contents Section ......................................... 9)' 160 ( 4.5. Body of the Document .............................................. 9)' 161 ( 4.5.1. Introduction Section ........................................ 10)' 162 ( 4.5.2. Requirements Language Section ............................... 10)' 163 ( 4.5.3. Internationalization Considerations Section ................. 10)' 164 ( 4.5.4. Security Considerations Section ............................. 10)' 165 ( 4.5.5. References Section .......................................... 11)' 166 ( 4.5.5.1. URIs in Specification Documents ........................ 11)' 167 ( 4.5.5.2. Referencing Specification Documents .................... 12)' 168 ( 4.5.5.3. Referencing Other Standards Development Organizations .. 13)' 169 ( 4.6. Acknowledgements Section ......................................... 13)' 170 ( 4.7. Contributors Section ............................................. 13)' 171 ( 4.8. Author Information Section ....................................... 14)' 172 ( 5. Security Considerations ............................................... 14)' 173 ( 6. Normative References .................................................. 15)' 174 ( Acknowledgements ......................................................... 15)' 175 ( Author Information ....................................................... 15)' 176 ()' 177 ()' 178 ()' 179 ()' 180 ()' 181 ()' 182 ()' 183 ()' 184 ()' 185 ()' 186 ()' 187 ()' 188 ()' 189 ()' 190 ()' 191 ()' 192 ()' 193 ()' 194 (Bron [Page 2])' 195 ET 196 endstream 197 endobj 198 11 0 obj 199 3669 200 endobj 201 12 0 obj 202 << 203 /Type /Page 204 /Parent 3 0 R 205 /Resources 5 0 R 206 /Contents 13 0 R 207 >> 208 endobj 209 13 0 obj 210 << 211 /Length 14 0 R 212 >> 213 stream 214 BT 215 /F1 10 Tf 216 1 0 0 1 50 802 Tm 217 12 TL 218 (SD0003 Specification Style Guide June 2020)' 219 ()' 220 (1. Introduction)' 221 ()' 222 ( The ultimate goal of the Specification publication process is to produce)' 223 ( documents that are readable, clear, consistent, and reasonably uniform. The)' 224 ( basic formatting conventions for Specification Documents were established in)' 225 ( August 2018 [SD0000]. This document describes the fundamental and unique)' 226 ( style conventions and editorial policies for Specification Documents. It is)' 227 ( intended as a stable, infrequently updated reference for authors, editors,)' 228 ( and reviewers.)' 229 ()' 230 ( The world of technical publishing has generally accepted rules for grammar,)' 231 ( punctuation, capitalization, sentence length and complexity, parallelism,)' 232 ( etc. These generally accepted rules are to be followed within Specification)' 233 ( Documents.)' 234 ()' 235 (2. Key Words)' 236 ()' 237 ( In many standards track documents several words are used to signify the)' 238 ( requirements in the specification. These words are often capitalized. This)' 239 ( section defines these words as they should be interpreted in Specification)' 240 ( Documents. Authors who follow these guidelines should incorporate this)' 241 ( phrase near the beginning of their document:)' 242 ()' 243 ( The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",)' 244 ( "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this)' 245 ( document are to be interpreted as described in SD0003.)' 246 ()' 247 ( Note that the force of these words is modified by the requirement level of)' 248 ( the document in which they are used.)' 249 ()' 250 (2.1. MUST)' 251 ()' 252 ( This word, or the terms "REQUIRED" and "SHALL", mean that the definition is)' 253 ( an absolute requirement of the specification.)' 254 ()' 255 (2.2. MUST NOT)' 256 ()' 257 ( This phrase, or the phrase "SHALL NOT", mean that the definition is an)' 258 ( absolute prohibition of the specification.)' 259 ()' 260 (2.3. SHOULD)' 261 ()' 262 ( This word, or the adjective "RECOMMENDED", mean that there may exist valid)' 263 ( reasons in particular circumstances to ignore a particular item, but the full)' 264 ( implications must be understood and carefully weighed before choosing a)' 265 ( different course.)' 266 ()' 267 (2.4. SHOULD NOT)' 268 ()' 269 ( This phrase, or the phrase "NOT RECOMMENDED", mean that there may exist)' 270 ( valid reasons in particular circumstances when the particular behavior is)' 271 ( acceptable or even useful, but the full implications should be understood)' 272 ( and the case carefully weighed before implementing any behavior described)' 273 ( with this label.)' 274 ()' 275 ()' 276 ()' 277 ()' 278 ()' 279 ()' 280 (Bron [Page 3])' 281 ET 282 endstream 283 endobj 284 14 0 obj 285 2744 286 endobj 287 15 0 obj 288 << 289 /Type /Page 290 /Parent 3 0 R 291 /Resources 5 0 R 292 /Contents 16 0 R 293 >> 294 endobj 295 16 0 obj 296 << 297 /Length 17 0 R 298 >> 299 stream 300 BT 301 /F1 10 Tf 302 1 0 0 1 50 802 Tm 303 12 TL 304 (SD0003 Specification Style Guide June 2020)' 305 ()' 306 (2.5. MAY)' 307 ()' 308 ( This word, or the adjective "OPTIONAL", mean that an item is truly)' 309 ( optional. One vendor may choose to include the item because a particular)' 310 ( marketplace requires it or because the vendor feels that it enhances the)' 311 ( product while another vendor may omit the same item. An implementation)' 312 ( which does not include a particular option MUST be prepared to interoperate)' 313 ( with another implementationn which does include the option, though perhaps)' 314 ( with reduced functionality. In the same vein an implementation which does)' 315 ( include a particular option MUST be prepared to interoperate with another)' 316 ( implementation which does not include the option \(except, of course, for the)' 317 ( feature the option provides\).)' 318 ()' 319 (2.6. Guidance in the use of these Imperatives)' 320 ()' 321 ( Imperatives of the type defined in this section must be used with care and)' 322 ( sparingly. In particular, they MUST only be used where it is actually)' 323 ( required for interoperation or to limit behavior which has potential for)' 324 ( causing harm \(e.g., limiting retransmissions\). For example, they must not)' 325 ( be used to try to impose a particular method on implementors where the)' 326 ( method is not required for interoperability.)' 327 ()' 328 (2.7. Security Considerations)' 329 ()' 330 ( These terms are frequently used to specify behavior with security)' 331 ( implications. The effects on security of not implementing a MUST or SHOULD,)' 332 ( or doing something the specification says MUST NOT or SHOULD NOT be done)' 333 ( may be very subtle. Document authors should take the time to elaborate the)' 334 ( security implementations of not following recommendations or requirements)' 335 ( as most implementors will not have had the benefit of the experience and)' 336 ( discussions that produced the specification.)' 337 ()' 338 ()' 339 ()' 340 ()' 341 ()' 342 ()' 343 ()' 344 ()' 345 ()' 346 ()' 347 ()' 348 ()' 349 ()' 350 ()' 351 ()' 352 ()' 353 ()' 354 ()' 355 ()' 356 ()' 357 ()' 358 ()' 359 ()' 360 ()' 361 ()' 362 ()' 363 ()' 364 ()' 365 ()' 366 (Bron [Page 4])' 367 ET 368 endstream 369 endobj 370 17 0 obj 371 2170 372 endobj 373 18 0 obj 374 << 375 /Type /Page 376 /Parent 3 0 R 377 /Resources 5 0 R 378 /Contents 19 0 R 379 >> 380 endobj 381 19 0 obj 382 << 383 /Length 20 0 R 384 >> 385 stream 386 BT 387 /F1 10 Tf 388 1 0 0 1 50 802 Tm 389 12 TL 390 (SD0003 Specification Style Guide June 2020)' 391 ()' 392 (3. Specification Style Conventions)' 393 ()' 394 ( This Style Guide does not use the terminology as defined in section 2.)' 395 ()' 396 (3.1. Language)' 397 ()' 398 ( The Specification publication language is English. Spelling may be either)' 399 ( American or British, as long as an individual document is internally)' 400 ( consistent. Where both American and British English spelling are used within)' 401 ( a document or cluster of documents, the text will have to be modified to be)' 402 ( consistent with American English spelling.)' 403 ()' 404 (3.2. Punctuation)' 405 ()' 406 ( - No overstriking \(or underlining\) is allowed.)' 407 ()' 408 ( - When a sentence ended by a period is immediately followed by another)' 409 ( sentence, there must be two blank spaces after the period.)' 410 ()' 411 ( - A comma is used before the last item of a series, e.g.,)' 412 ()' 413 ( "TCP service is reliable, ordered, and full duplex")' 414 ()' 415 ( - When quoting literal text, punctuation is placed outside quotation marks,)' 416 ( e.g.,)' 417 ()' 418 ( Search for the string "Error Found".)' 419 ()' 420 ( When quoting general text, such as general text from another Specification)' 421 ( Document, punctuation may be included within the quotation marks.)' 422 ()' 423 ( Quotation marks are not necessary when text is formatted as a block)' 424 ( quotation.)' 425 ()' 426 (3.3. DNS Names and URIs)' 427 ()' 428 ( Angle brackets are strongly recommended around URIs, e.g.,)' 429 ()' 430 ( <http://example.org/>)' 431 ()' 432 (3.4. Capitalization)' 433 ()' 434 ( - Capitalizationn must be consistent within the document and ideally should)' 435 ( be consistent with related Specification Documents.)' 436 ()' 437 ( - Per CMOS guidelines, the major words in document titles and section titles)' 438 ( should be capitalized \(this is sometimes called "title cases"\). Typically,)' 439 ( all words in a title will be capitalized, except for internal articles,)' 440 ( prepositions, and conjunctions.)' 441 ()' 442 ( - Section titles that are in sentence form will follow typical sentence)' 443 ( capitalization.)' 444 ()' 445 ( - Titles of figures may be in sentence form or use title case.)' 446 ()' 447 ()' 448 ()' 449 ()' 450 ()' 451 ()' 452 (Bron [Page 5])' 453 ET 454 endstream 455 endobj 456 20 0 obj 457 2299 458 endobj 459 21 0 obj 460 << 461 /Type /Page 462 /Parent 3 0 R 463 /Resources 5 0 R 464 /Contents 22 0 R 465 >> 466 endobj 467 22 0 obj 468 << 469 /Length 23 0 R 470 >> 471 stream 472 BT 473 /F1 10 Tf 474 1 0 0 1 50 802 Tm 475 12 TL 476 (SD0003 Specification Style Guide June 2020)' 477 ()' 478 (3.5. Citations)' 479 ()' 480 ( - References and citations must match. That is, there must be a reference)' 481 ( for each citation used. and vice versa.)' 482 ()' 483 ( - Citations must be enclosed in square brackets \(e.g., "[CITE1]"\).)' 484 ()' 485 ( - A citation/reference tag must not contain spaces.)' 486 ()' 487 ( Example: "[SD0003]" rather than "[SD 0003]")' 488 ()' 489 ( However, the proper textual naming of a Specification contains a space.)' 490 ()' 491 ( Example: "See SD 0003 for more information.")' 492 ()' 493 ( - Cross-references within the body of the document and to other documents)' 494 ( must use section numbers rather than page numbers, as pagination may change)' 495 ( per format and device.)' 496 ()' 497 (3.6. Abbreviation Rules)' 498 ()' 499 ( Abbreviations should be expanded in document titles and upon first use in the)' 500 ( document. The full expansion of the text should be followed by the)' 501 ( abbreviation itself in parenthesis. The exception is an abbreviation that is)' 502 ( so common that the readership of Specification Documents can be expected to)' 503 ( recognize it immediately; examples include \(but are not limited to\) TCP, IP,)' 504 ( SNMP, and HTTP. Some cases are marginal, and the author should make the)' 505 ( final judgement, weighing obscurity agains complexity.)' 506 ()' 507 ()' 508 ()' 509 ()' 510 ()' 511 ()' 512 ()' 513 ()' 514 ()' 515 ()' 516 ()' 517 ()' 518 ()' 519 ()' 520 ()' 521 ()' 522 ()' 523 ()' 524 ()' 525 ()' 526 ()' 527 ()' 528 ()' 529 ()' 530 ()' 531 ()' 532 ()' 533 ()' 534 ()' 535 ()' 536 ()' 537 ()' 538 (Bron [Page 6])' 539 ET 540 endstream 541 endobj 542 23 0 obj 543 1618 544 endobj 545 24 0 obj 546 << 547 /Type /Page 548 /Parent 3 0 R 549 /Resources 5 0 R 550 /Contents 25 0 R 551 >> 552 endobj 553 25 0 obj 554 << 555 /Length 26 0 R 556 >> 557 stream 558 BT 559 /F1 10 Tf 560 1 0 0 1 50 802 Tm 561 12 TL 562 (SD0003 Specification Style Guide June 2020)' 563 ()' 564 (4. Structure of a Specification Document)' 565 ()' 566 ( A published Specification Document will largely contain the elements in the)' 567 ( following list. Some of these sections are required, as noted. Sections are)' 568 ( allowed to contain nothing but subsections. The rules for each of these)' 569 ( elements are described in more details below.)' 570 ()' 571 ( First-page header [Required])' 572 ( Title [Required])' 573 ( Abstract [Required])' 574 ( Copyright Notice [Required])' 575 ( Table of Contents [Required])' 576 ( Body of the Document [Required])' 577 ( 1. Introduction [Required])' 578 ( 2. Requirements Language)' 579 ( 3. ...)' 580 ( MAIN BODY OF THE TEXT)' 581 ( 6. ...)' 582 ( 7. Internationalization Considerations)' 583 ( 8. Security Considerations [Required])' 584 ( 9. References)' 585 ( 9.1. Normative References)' 586 ( 9.2. Informative References)' 587 ( Acknowledgements)' 588 ( Contributors)' 589 ( Author Information [Required])' 590 ()' 591 ( Within the body of the document, the order shown above is strongly)' 592 ( recommended. Exceptions may be questioned. Outside the body of the)' 593 ( document, the order above is required. The section numbers above are for)' 594 ( illustrative purposes; they are not intended to correspond to required)' 595 ( numbering in a Specification Document.)' 596 ()' 597 (4.1. First-Page header)' 598 ()' 599 ( Headers will follow the format described in "RFC Streams, Headers, and)' 600 ( Boilerplates" [RFC5741] and it's successors. In addition, the following)' 601 ( conventions will apply.)' 602 ()' 603 ()' 604 ()' 605 ()' 606 ()' 607 ()' 608 ()' 609 ()' 610 ()' 611 ()' 612 ()' 613 ()' 614 ()' 615 ()' 616 ()' 617 ()' 618 ()' 619 ()' 620 ()' 621 ()' 622 ()' 623 ()' 624 (Bron [Page 7])' 625 ET 626 endstream 627 endobj 628 26 0 obj 629 2077 630 endobj 631 27 0 obj 632 << 633 /Type /Page 634 /Parent 3 0 R 635 /Resources 5 0 R 636 /Contents 28 0 R 637 >> 638 endobj 639 28 0 obj 640 << 641 /Length 29 0 R 642 >> 643 stream 644 BT 645 /F1 10 Tf 646 1 0 0 1 50 802 Tm 647 12 TL 648 (SD0003 Specification Style Guide June 2020)' 649 ()' 650 (4.1.1. Author/Editor)' 651 ()' 652 ( The determination of who should be listed as an author or editor on a)' 653 ( Specification Document is made by the stream.)' 654 ()' 655 ( The author's name \(initial followed by family name\) appears on the first line)' 656 ( of the heading. Some variation, such as additional initials or)' 657 ( capitalization of family name, is acceptable. Once the author has selected)' 658 ( how their name should appear, they should use that display consistently in)' 659 ( all of their documents.)' 660 ()' 661 ( The total number of authors or editors on the first page is generally limited)' 662 ( to five individuals and their affiliations. If there is a request for more)' 663 ( than five authors, the stream-approving body needs to considor if one or two)' 664 ( editors should have primary responsibility for this document, with the other)' 665 ( individuals listed in the Contributors or Acknowledgements section. There)' 666 ( must be a direct correlation of authors and editors in the document header)' 667 ( and the Authors' Information section. These are the individuals that must)' 668 ( sign off on the document and respond to inquiries.)' 669 ()' 670 (4.1.2. Organization)' 671 ()' 672 ( The author's organization is indicated on the line following the author's)' 673 ( name.)' 674 ()' 675 ( For multiple authors, each author name appears on its own line, followed by)' 676 ( that author's organization. When more than one author is affiliated with the)' 677 ( same organization, the organization can be "factored out", appearing only)' 678 ( once following the corresponding Author lines. However, such factoring is)' 679 ( inappropriate when it would force an unacceptable reordering of author names.)' 680 ()' 681 ( If an author can not or will not provide an affiliation for any reason,)' 682 ( "Independent", "Individual Contributor", "Retired", or some other term that)' 683 ( appropriately describes the author's affiliation may be used. Alternatively,)' 684 ( a blank line may be included in the document header where no affiliation is)' 685 ( provided.)' 686 ()' 687 (4.1.3. Updates and Obsoletes)' 688 ()' 689 ( When a Specification Document obsoletes or updates a previously published)' 690 ( Specification Document or Specification Documents, this information is)' 691 ( included in the document header. For example:)' 692 ()' 693 ( "Updates: nnnn" or "Updates: nnnn, ..., nnnn")' 694 ()' 695 ( "Obsoletes: nnnn" or "Obsoletes: nnnn, ..., nnnn")' 696 ()' 697 ( If the document updates or obsoletes more than one document, numbers will be)' 698 ( listed in ascending order.)' 699 ()' 700 ()' 701 ()' 702 ()' 703 ()' 704 ()' 705 ()' 706 ()' 707 ()' 708 ()' 709 ()' 710 (Bron [Page 8])' 711 ET 712 endstream 713 endobj 714 29 0 obj 715 2776 716 endobj 717 30 0 obj 718 << 719 /Type /Page 720 /Parent 3 0 R 721 /Resources 5 0 R 722 /Contents 31 0 R 723 >> 724 endobj 725 31 0 obj 726 << 727 /Length 32 0 R 728 >> 729 stream 730 BT 731 /F1 10 Tf 732 1 0 0 1 50 802 Tm 733 12 TL 734 (SD0003 Specification Style Guide June 2020)' 735 ()' 736 (4.2. Full Title)' 737 ()' 738 ( The title must be centered below the rest of the heading, preceded by two)' 739 ( blank lines and followed by one blank line.)' 740 ()' 741 ( Choosing a good title for a Specification Document can be a challenge. A good)' 742 ( title should fairly represent the scope and purpose of the document without)' 743 ( being either too general or too specific and lengthy.)' 744 ()' 745 ( Abbreviations in a title must generally be expanded when first encountered)' 746 ( \(See section 3.6 for additional guidance on abbreviations\).)' 747 ()' 748 ( It is often helpful to follow the expansion with the parenthesized)' 749 ( abbreviation, as in the following example:)' 750 ()' 751 ( Encoding Rules for the)' 752 ( Common Routing Encapsulation Extension Protocol \(CREEP\))' 753 ()' 754 (4.3. Abstract Section)' 755 ()' 756 ( Every Specification Document must have an Abstract that provides a concise)' 757 ( and comprehensive overview of the purpose and contents of the entire)' 758 ( document, to give a technically knowledgeable reader a general overview of)' 759 ( the function of the document.)' 760 ()' 761 ( Composing a useful Abstract generally requires thought and care. Usually, an)' 762 ( Abstract should begin with a phrase like "This memo ..." or "This document)' 763 ( ...". A satisfactory Abstract can often be constructed in part from material)' 764 ( within the Introduction section, but an effective Abstract may be shorter,)' 765 ( less detailed, and perhaps broader in scope than the Introduction. Simply)' 766 ( copying and pasting the first few paragraphs of the Introduction is allowed,)' 767 ( but it may result in an Abstract that is both incomplete and redundant. Note)' 768 ( also that an Abstract is not a subsitute for an Introduction; the)' 769 ( Specification Document should be self-contained as if there were no Abstract.)' 770 ()' 771 ( Similarly, the Abstract should be complete in itself. It will appear is)' 772 ( isolation in publication announcements. Therefore, the Abstract must not)' 773 ( contain citations.)' 774 ()' 775 (4.4. Table of Contents Section)' 776 ()' 777 ( A Table of Contents \(TOC\) is required in all Specification Documents. It must)' 778 ( be positioned after the Copyright Notice and before the Introduction.)' 779 ()' 780 (4.5. Body of the Document)' 781 ()' 782 ( Following the TOC is the body of the document.)' 783 ()' 784 ( Each Specification Document must include an Introduction section that \(among)' 785 ( other things\) explains the motivation for the Specification and \(if)' 786 ( appropriate\) describes the applicability of the document, e.g., whether it)' 787 ( specifies a protocol, provides a discussion of some problem, is simply of)' 788 ( interest to the Internet community, or provides a status report on some)' 789 ( activity. The body of the document and the Abstract must be self-contained)' 790 ( and separable. This may result in some duplication of text between the)' 791 ( Abstract and the Introduction; this is acceptable.)' 792 ()' 793 ()' 794 ()' 795 ()' 796 (Bron [Page 9])' 797 ET 798 endstream 799 endobj 800 32 0 obj 801 3154 802 endobj 803 33 0 obj 804 << 805 /Type /Page 806 /Parent 3 0 R 807 /Resources 5 0 R 808 /Contents 34 0 R 809 >> 810 endobj 811 34 0 obj 812 << 813 /Length 35 0 R 814 >> 815 stream 816 BT 817 /F1 10 Tf 818 1 0 0 1 50 802 Tm 819 12 TL 820 (SD0003 Specification Style Guide June 2020)' 821 ()' 822 (4.5.1. Introduction Section)' 823 ()' 824 ( The Introduction section should always be the first section following the)' 825 ( TOC. While "Introduction" is recommended, authors may choose alternate)' 826 ( titles such as "Overview" or "Background". These alternates are acceptable.)' 827 ()' 828 (4.5.2. Requirements Language Section)' 829 ()' 830 ( Some document use certain capitalized words \("MUST", "SHOULD", etc.\) to)' 831 ( specify precise requirement levels for technical features. Section 2 of this)' 832 ( document defines a default interpretation of these capitalized words in)' 833 ( Specification Documents. If this interpretation is used, this document must)' 834 ( be citet and included as a normative reference. Otherwise, the correct)' 835 ( interpretation must be specified in the document.)' 836 ()' 837 ( This section must appear as a part of the body of the memo \(as defined by)' 838 ( this document\). It must appear as part of, or subsequent to, the)' 839 ( Introduction section.)' 840 ()' 841 ( These words are considered part of the technical content of the document and)' 842 ( are intended to provide guidance to implementers about specific technical)' 843 ( features, generally governed by considerations of interopretability.)' 844 ()' 845 (4.5.3. Internationalization Considerations Section)' 846 ()' 847 ( All documents that deal with internationalization issues should have a)' 848 ( section describing those issues.)' 849 ()' 850 (4.5.4. Security Considerations Section)' 851 ()' 852 ( All Specification Documents must contain a section that discusses the)' 853 ( security considerations relevant to the specification.)' 854 ()' 855 ()' 856 ()' 857 ()' 858 ()' 859 ()' 860 ()' 861 ()' 862 ()' 863 ()' 864 ()' 865 ()' 866 ()' 867 ()' 868 ()' 869 ()' 870 ()' 871 ()' 872 ()' 873 ()' 874 ()' 875 ()' 876 ()' 877 ()' 878 ()' 879 ()' 880 ()' 881 ()' 882 (Bron [Page 10])' 883 ET 884 endstream 885 endobj 886 35 0 obj 887 1900 888 endobj 889 36 0 obj 890 << 891 /Type /Page 892 /Parent 3 0 R 893 /Resources 5 0 R 894 /Contents 37 0 R 895 >> 896 endobj 897 37 0 obj 898 << 899 /Length 38 0 R 900 >> 901 stream 902 BT 903 /F1 10 Tf 904 1 0 0 1 50 802 Tm 905 12 TL 906 (SD0003 Specification Style Guide June 2020)' 907 ()' 908 (4.5.5. References Section)' 909 ()' 910 ( The reference list is solely for recording reference entries. Introductory)' 911 ( text is not allowed.)' 912 ()' 913 ( The Specification Style allows the use of any of a variety of reference)' 914 ( styles, as long as they are used consistently within a document. However,)' 915 ( where necessary, some reference styles have been described for use within the)' 916 ( Series. See the examples in this document.)' 917 ()' 918 ( Reference lists must indicate whether each reference is normative or)' 919 ( informative, where normative references are essential to implementing or)' 920 ( understanding content of the Specification Document and informative)' 921 ( references provide additional information. When both normative and)' 922 ( informative references exist, the references section should be split into two)' 923 ( subsection:)' 924 ()' 925 ( s. References)' 926 ()' 927 ( s.1. Normative References)' 928 ()' 929 ( xxx)' 930 ( ...)' 931 ( xxx)' 932 ()' 933 ( s.2. Informative References)' 934 ()' 935 ( xxx)' 936 ( ...)' 937 ( xxx)' 938 ()' 939 ( References will generally appear in alphanumeric order by citation tag.)' 940 ( Where there are only normative or informative references, no subsection is)' 941 ( required; the top-level section should say "Normative References" or)' 942 ( "Informative References".)' 943 ()' 944 (4.5.5.1. URIs in Specification Documents)' 945 ()' 946 ( The use of URIs in references is acceptable, as long as the URI is the most)' 947 ( stable \(i.e., unlikely to change and expected to be continuously available\))' 948 ( and direct reference possible. The URI will be verified as valid during the)' 949 ( Specification Document editorial process.)' 950 ()' 951 ( If a dates URI \(one that includes a timestamp for the page\) is available for)' 952 ( a referenced web page, its use is required.)' 953 ()' 954 ( Note that URIs may not be the sole information provided for a reference)' 955 ( entry.)' 956 ()' 957 ()' 958 ()' 959 ()' 960 ()' 961 ()' 962 ()' 963 ()' 964 ()' 965 ()' 966 ()' 967 ()' 968 (Bron [Page 11])' 969 ET 970 endstream 971 endobj 972 38 0 obj 973 2169 974 endobj 975 39 0 obj 976 << 977 /Type /Page 978 /Parent 3 0 R 979 /Resources 5 0 R 980 /Contents 40 0 R 981 >> 982 endobj 983 40 0 obj 984 << 985 /Length 41 0 R 986 >> 987 stream 988 BT 989 /F1 10 Tf 990 1 0 0 1 50 802 Tm 991 12 TL 992 (SD0003 Specification Style Guide June 2020)' 993 ()' 994 (4.5.5.2. Referencing Specification Documents)' 995 ()' 996 ( The following format is required for referencing Specification Documents.)' 997 ( Note the ordering for multiple authors: the format of the name of the last)' 998 ( author listed is different than that of all previous authors in the list.)' 999 ()' 1000 ( For one author or editor:)' 1001 ()' 1002 ( [SDXXXX] Last name, First initial., Ed. \(if applicable\),)' 1003 ( "Specification Title", Sub-series number \(if applicable\),)' 1004 ( Specification number, Date of publication,)' 1005 ( <https://finwo.nl/specifications/#.pdf>)' 1006 ()' 1007 ( Example:)' 1008 ()' 1009 ( [SD0003] Bron, R.,)' 1010 ( "Specification Style Guide")' 1011 ( SD 0003, June 2020)' 1012 ( <https://finwo.nl/specifications/0003.pdf>)' 1013 ()' 1014 ( For two authors or editors:)' 1015 ()' 1016 ( [SDXXXX] Last name, First initial., Ed. \(if applicable\))' 1017 ( and First initial. Last name, Ed. \(if applicable\),)' 1018 ( "Specification Title", Sub-series number \(if applicable\))' 1019 ( Specification number, Date of publication)' 1020 ( <https://finwo.nl/specifications/#.pdf>)' 1021 ()' 1022 ( For three or more authors or editors:)' 1023 ()' 1024 ( [SDXXXX] Last name, First initial., Ed. \(if applicable\),)' 1025 ( Last name, First initial., Ed. \(if applicable\),)' 1026 ( and First initial. Last name, Ed. \(if applicable\),)' 1027 ( "Specification Title", Sub-series number \(if applicable\))' 1028 ( Specification number, Date of publication)' 1029 ( <https://finwo.nl/specifications/#.pdf>)' 1030 ()' 1031 ()' 1032 ()' 1033 ()' 1034 ()' 1035 ()' 1036 ()' 1037 ()' 1038 ()' 1039 ()' 1040 ()' 1041 ()' 1042 ()' 1043 ()' 1044 ()' 1045 ()' 1046 ()' 1047 ()' 1048 ()' 1049 ()' 1050 ()' 1051 ()' 1052 ()' 1053 ()' 1054 (Bron [Page 12])' 1055 ET 1056 endstream 1057 endobj 1058 41 0 obj 1059 1930 1060 endobj 1061 42 0 obj 1062 << 1063 /Type /Page 1064 /Parent 3 0 R 1065 /Resources 5 0 R 1066 /Contents 43 0 R 1067 >> 1068 endobj 1069 43 0 obj 1070 << 1071 /Length 44 0 R 1072 >> 1073 stream 1074 BT 1075 /F1 10 Tf 1076 1 0 0 1 50 802 Tm 1077 12 TL 1078 (SD0003 Specification Style Guide June 2020)' 1079 ()' 1080 (4.5.5.3. Referencing Other Standards Development Organizations \(SDOs\))' 1081 ()' 1082 ( The following format is suggested when referencing a document or standard)' 1083 ( from another SDO in which authors are listed:)' 1084 ()' 1085 ( [SYMBOLIC-TAG])' 1086 ( Last name, First initial. and First initial. Last name, "Document)' 1087 ( Title", Document reference number, Date of publication, <URI if)' 1088 ( available>.)' 1089 ()' 1090 ( [W3C.REC-xml11])' 1091 ( Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., Yergeau, F.,)' 1092 ( and J. Cowan, "Extensible Markup Language \(XML\) 1.1 \(Second)' 1093 ( Edition\)", W3C Recommendation REC-xml11-20060816, August 2006,)' 1094 ( <http://www.w3.org/TR/2006/REC-xml11-20060816>.)' 1095 ()' 1096 ( Note that the order of authors in the list is the same as order shown on the)' 1097 ( actual document and that the common, abbreviated form of SDO is used.)' 1098 ()' 1099 ( Alternatively, when no list of authors is available, the following format is)' 1100 ( recommended:)' 1101 ()' 1102 ( [SYMBOLIC-TAG] Organization, "Document Title", Document reference number,)' 1103 ( Date of publication, <URI if available>.)' 1104 ()' 1105 ( Example:)' 1106 ()' 1107 ( [IEEE802.1Q] IEEE, "Local and Metropolitan Area Networks -- Media Access)' 1108 ( Control \(MAC\) Bridges and Virtual Bridged Local Area)' 1109 ( Networks", IEEE Std 802.1Q-2011, August 2011,)' 1110 ( <http://standards.ieee.org/findstds/standard/)' 1111 ( 802.1Q-2011.html>.)' 1112 ()' 1113 (4.6. Acknowledgements Section)' 1114 ()' 1115 ( This optional section may be used instead of, or in addition to, a)' 1116 ( Contributors section. It is often used by authors to publicly thank those)' 1117 ( who have provided feedback regarding a document and to note any documents)' 1118 ( from which text was borrowed.)' 1119 ()' 1120 (4.7. Contributors Section)' 1121 ()' 1122 ( This optional section acknowledges those who have made significant)' 1123 ( contributions to the document.)' 1124 ()' 1125 ( In a similar fashion to the Author Information section, the determination)' 1126 ( of who should be listed as a contributor is made by the stream.)' 1127 ()' 1128 ( The Contributors section may include brief statements about the nature of)' 1129 ( particular contributions \("Sam contributed Section 3"\), and it may also)' 1130 ( include affiliations of listed contributors. At the descretionnn of the)' 1131 ( author\(s\), contact addresses may also be included in the Contributors)' 1132 ( section, for those contributors whose knowledge makes them useful for future)' 1133 ( contacts for information about the Specification Document. The format of any)' 1134 ( contact information should be similar to the format of information in the)' 1135 ( Author Information section.)' 1136 ()' 1137 ()' 1138 ()' 1139 ()' 1140 (Bron [Page 13])' 1141 ET 1142 endstream 1143 endobj 1144 44 0 obj 1145 2986 1146 endobj 1147 45 0 obj 1148 << 1149 /Type /Page 1150 /Parent 3 0 R 1151 /Resources 5 0 R 1152 /Contents 46 0 R 1153 >> 1154 endobj 1155 46 0 obj 1156 << 1157 /Length 47 0 R 1158 >> 1159 stream 1160 BT 1161 /F1 10 Tf 1162 1 0 0 1 50 802 Tm 1163 12 TL 1164 (SD0003 Specification Style Guide June 2020)' 1165 ()' 1166 (4.8. Author Information Section)' 1167 ()' 1168 ( This required section gives contact information for the author\(s\) listed in)' 1169 ( the first-page header.)' 1170 ()' 1171 ( Contact information must include a long-lived email address and optionally)' 1172 ( may include a postal address, telephone number, and/or Public PGP key. If)' 1173 ( the postal address is included, it should include the country name, using the)' 1174 ( English short name listed by the ISO 3166 Maintenance Agency [ISO_OBP]. The)' 1175 ( purpose of this section is to \(1\) unambiguously define author identity \(e.g.,)' 1176 ( the John Smith who works for FooBar Systems\) and \(2\) provide contact)' 1177 ( information for future readers who have questions and comments.)' 1178 ()' 1179 ( The practice of munged email addresses \(i.e., altering an email address to)' 1180 ( make it less readable to bots and web crawlers to avoid spam\) is not)' 1181 ( appropriate in an archival document series. Author contact information is)' 1182 ( provided so that the readers can easily contact the author with questions)' 1183 ( and/or comments. Address munging is not allowed in Specification Documents.)' 1184 ()' 1185 (5. Security Considerations)' 1186 ()' 1187 ( This document has no security considerations.)' 1188 ()' 1189 ()' 1190 ()' 1191 ()' 1192 ()' 1193 ()' 1194 ()' 1195 ()' 1196 ()' 1197 ()' 1198 ()' 1199 ()' 1200 ()' 1201 ()' 1202 ()' 1203 ()' 1204 ()' 1205 ()' 1206 ()' 1207 ()' 1208 ()' 1209 ()' 1210 ()' 1211 ()' 1212 ()' 1213 ()' 1214 ()' 1215 ()' 1216 ()' 1217 ()' 1218 ()' 1219 ()' 1220 ()' 1221 ()' 1222 ()' 1223 ()' 1224 ()' 1225 ()' 1226 (Bron [Page 14])' 1227 ET 1228 endstream 1229 endobj 1230 47 0 obj 1231 1578 1232 endobj 1233 48 0 obj 1234 << 1235 /Type /Page 1236 /Parent 3 0 R 1237 /Resources 5 0 R 1238 /Contents 49 0 R 1239 >> 1240 endobj 1241 49 0 obj 1242 << 1243 /Length 50 0 R 1244 >> 1245 stream 1246 BT 1247 /F1 10 Tf 1248 1 0 0 1 50 802 Tm 1249 12 TL 1250 (SD0003 Specification Style Guide June 2020)' 1251 ()' 1252 (6. Informative References)' 1253 ()' 1254 ( [SD0000] Bron, R., "Specification Format", SD 0000, August 2018)' 1255 ( <https://finwo.nl/specifications/0000.pdf>)' 1256 ()' 1257 ( [RFC5741] Daigle, L., Ed., Kolkman, O., Ed., and IAB, "RFC Streams,)' 1258 ( Headers, and Boilerplates", RFC 5741, December 2009,)' 1259 ( <http://www.rfc-editor.org/info/rfc5741>.)' 1260 ()' 1261 ( [ISO_OBP] ISO, "Online Browsing Platform \(OBP\)",)' 1262 ( <https://www.iso.org/obp/ui/>.)' 1263 ()' 1264 (Acknowledgements)' 1265 ()' 1266 ( This document relies heavily on RFC 7322 [RFC7322]; as such, I am grateful to)' 1267 ( the authors of those documents for putting their time and effort into the RFC)' 1268 ( Series.)' 1269 ()' 1270 (Author Information)' 1271 ()' 1272 ( R. Bron)' 1273 ( EMail: robin@finwo.nl)' 1274 ()' 1275 ()' 1276 ()' 1277 ()' 1278 ()' 1279 ()' 1280 ()' 1281 ()' 1282 ()' 1283 ()' 1284 ()' 1285 ()' 1286 ()' 1287 ()' 1288 ()' 1289 ()' 1290 ()' 1291 ()' 1292 ()' 1293 ()' 1294 ()' 1295 ()' 1296 ()' 1297 ()' 1298 ()' 1299 ()' 1300 ()' 1301 ()' 1302 ()' 1303 ()' 1304 ()' 1305 ()' 1306 ()' 1307 ()' 1308 ()' 1309 ()' 1310 ()' 1311 ()' 1312 (Bron [Page 15])' 1313 ET 1314 endstream 1315 endobj 1316 50 0 obj 1317 1129 1318 endobj 1319 3 0 obj 1320 << 1321 /Type /Pages 1322 /Count 15 1323 /MediaBox [ 0 0 595 842 ] 1324 /Kids [ 6 0 R 9 0 R 12 0 R 15 0 R 18 0 R 21 0 R 24 0 R 27 0 R 30 0 R 33 0 R 36 0 R 39 0 R 42 0 R 45 0 R 48 0 R ] 1325 >> 1326 endobj 1327 xref 1328 0 51 1329 0000000000 65535 f 0000000009 00000 n 0000000155 00000 n 0000035953 00000 n 0000000204 00000 n 0000000282 00000 n 0000000353 00000 n 0000000433 00000 n 0000001537 00000 n 0000001557 00000 n 0000001638 00000 n 0000005361 00000 n 0000005382 00000 n 0000005464 00000 n 0000008262 00000 n 0000008283 00000 n 0000008365 00000 n 0000010589 00000 n 0000010610 00000 n 0000010692 00000 n 0000013045 00000 n 0000013066 00000 n 0000013148 00000 n 0000014820 00000 n 0000014841 00000 n 0000014923 00000 n 0000017054 00000 n 0000017075 00000 n 0000017157 00000 n 0000019987 00000 n 0000020008 00000 n 0000020090 00000 n 0000023298 00000 n 0000023319 00000 n 0000023401 00000 n 0000025355 00000 n 0000025376 00000 n 0000025458 00000 n 0000027681 00000 n 0000027702 00000 n 0000027784 00000 n 0000029768 00000 n 0000029789 00000 n 0000029871 00000 n 0000032911 00000 n 0000032932 00000 n 0000033014 00000 n 0000034646 00000 n 0000034667 00000 n 0000034749 00000 n 0000035932 00000 n trailer 1330 << 1331 /Size 51 1332 /Root 2 0 R 1333 /Info 1 0 R 1334 >> 1335 startxref 1336 36136 1337 %%EOF