ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for...
Transcript of ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for...
![Page 1: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/1.jpg)
ASBGuide00012016
ASBStyleGuideManualforStandards,TechnicalReportsandBestPracticeRecommendations
![Page 2: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/2.jpg)
![Page 3: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/3.jpg)
ASBGuide00012016
ASBStyleGuideManualforStandards,TechnicalReportsandBestPracticeRecommendations
ApprovedbytheAcademyStandardsBoardforusebytheAAFSStandardsBoard,LLC.March2016
AcademyStandardsBoard4200WisconsinAvenue,NW
Suite106‐310Washington,DC20016‐2143
Thisdocumentmaybedownloadedforfreeat:http://asb.aafs.org/
Allrightsreserved.Unlessotherwisespecified,nopartofthispublicationmaybereproducedorutilizedotherwiseinanyformorbyanymeans,electronicormechanical,including
photocopying,orpostingontheinternetoronanintranet,withoutpriorwrittenpermissionfromtheAcademyStandardsBoard,4200WisconsinAvenue,NW,Suite106‐310,Washington,
DC20016‐2143,asb.aafs.org.
Copyright©AcademyStandardsBoard2016
Keywords:Style,editing,layout,requirements,patents,standards,technicalreports,bestpracticerecommendations
ThisManualwasdevelopedtoprovideguidanceforpreparingdocumentsthatwillbepublishedbytheAAFSStandardsBoard(ASB).
![Page 4: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/4.jpg)
Foreword
TheAAFShasestablishedanorganizationdedicatedtodevelopingdocumentarystandardsforforensics,theAcademyStandardsBoard(ASB).ThisorganizationwillworkcloselywiththeForensicScienceStandardsBoardanditssubcommittees,whicharededicatedtocreatinganationalregistryofforensicstandards.ThedocumentisintendedtoassisttheconsensusbodiesandworkinggroupsindraftingdocumentstobepublishedbytheAAFSStandardsBoard.
![Page 5: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/5.jpg)
Acknowledgements
EditorialCommittee:
BradWing,TeresaAmbrosius,MaryMcKiel
![Page 6: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/6.jpg)
TableofContents
1 Preface...........................................................................................................................................................................1
2 GeneralGuidance......................................................................................................................................................1
3 DocumentLayoutforStandards.........................................................................................................................23.1. General..........................................................................................................................................................................23.2. CoverPage...................................................................................................................................................................23.3. TitlePage......................................................................................................................................................................23.4. Foreword......................................................................................................................................................................33.5. Acknowledgements..................................................................................................................................................33.6. TableofContents......................................................................................................................................................43.7. Scope(Section1)......................................................................................................................................................43.8. NormativeReferences(Section2).....................................................................................................................43.9. TermsandDefinitions(Section3).....................................................................................................................43.10. Requirements(Section4).....................................................................................................................................63.11. Conformance(Section5).......................................................................................................................................63.12. Annexes(LabeledAlphabeticallyinorder)...................................................................................................7
4 FiguresandTables...................................................................................................................................................7
5 DocumentLayoutforTechnicalReports........................................................................................................7
6 DocumentLayoutforBestPracticeRecommendations...........................................................................8
AnnexA(informative)ExpressionofProvisions........................................................................................................9
AnnexB(normative)PatentsandCopyrights...........................................................................................................11
AnnexC(informative)Numbers,UnitsofMeasurement,andEquations......................................................13
AnnexD(informative)SampleFormatforanASBDocument...........................................................................15
AnnexE(informative)Bibliography.............................................................................................................................18
TablesA.1 VerbalFormstoExpressRequirements..........................................................................................................9A.2 VerbalFormstoExpressRecommendations.............................................................................................10A.3 VerbalFormstoExpressPermission............................................................................................................10A.4 VerbalFormstoExpressPossibilityandCapability...............................................................................10
![Page 7: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/7.jpg)
ASBGuide0001‐2016
1
ASBStyleGuideManualforStandards,TechnicalReportsandBestPracticeRecommendations–2016Edition
1 Preface
ThisManualwasdevelopedtoprovideguidanceforpreparingdocumentsthatwillbepublishedbytheAAFSStandardsBoard(ASB)andsubmittedtotheAmericanNationalStandardsInstitute(ANSI).
ThisManualdrawsheavilyuponthefollowingsources:
ANSIStyleGuide‐Sheet‐20031
HowtoWriteStandards,InternationalOrganizationforStandardization(ISO)2
RecommendedPracticefortheDesignationandOrganizationofStandards,ANSI/SES1:2013,TheSocietyforStandardsProfessionals(SES)3
Eachstandard(S),technicalreport(TR)andbestpracticerecommendation(BPR)byconsensusbodiesoftheAAFSStandardsBoardshallconformtothisstylemanual.Thepurposeistoensureconsistencyinformat,andtomaximizeusabilityofthedocuments.WhendeviancefromthisManualisrecommendedbyadraftingworkinggroupofaconsensusbodythatconsensusbodyshallasktheSecretariatforpermissionandsuchdeviationshallbenotedintheForewordtothedocument.
2 GeneralGuidance
ThefollowingpointsshouldbeobservedwhenwritinganASBdocument:
1) ASBencouragestheuseofplainlanguage,totheextentpossible,initspublications.Itisrecognizedthatsomeveryspecializedterminologymaybenecessary,butsuchterminologyshouldbekepttoaminimum.
2) Theactivevoiceshouldbeusedinsentences.
3) Sentencesshouldbeshortandunambiguous.
4) Anytextcopiedfromanotherdocumentshallbefullyreferencedinafootnote.Thenameofthereferenceddocumentshallbeinitalics.
5) AsANSIstates:“Thecorrectverbformforindicatingarequirementis“shall.”Thecorrectverbformforindicatingarecommendationis“should”.Universallyaccepted“standardese”doesnotrecognize“must”.Use“shall”forindicatingamandatoryaspectoranaspecton
1TheANSIStyleGuide‐Sheet‐2003isavailableforfreeathttp://publicaa.ansi.org/sites/apdl/Documents/Standards%20Activities/American%20National%20Standards/Procedures,%20Guides,%20and%20Forms/New%20ANSI%20Style%20Guidesheet%202.docv2HowtoWriteStandardsisavailableforfreeatwww.iso.org/iso/how‐to‐write‐standards.pdf3RecommendedPracticefortheDesignationandOrganizationofStandards,ANSI/SES1:2013isavailableforafeeatwww.ses‐standards.org
![Page 8: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/8.jpg)
ASBGuide0001‐2016
2
whichthereisnooption.4Negativeformsare“shallnot”and“shouldnot”.“May”and“neednot”indicateacourseofactionthatispermissible.
6) Sincethedocumentswillbeavailableelectronically,cross‐referenceswithinthedocumentshallbehyperlinkedandcoloredgreen.Externalhyperlinksshallbecoloredblue.
7) AsANSIstates:“Makesureallstandardsonwhichthedocumentiscontingentarefullyandcorrectlylisted,withavailabilityfootnotes,wherenecessary.AnydocumentcitedinthestandardasbeingindispensablefortheapplicationofthestandardneedstobelistedinNormativeReferences.Informativereferences‐thoseforinformationonly,orforuseasbackgroundreading‐aretobelistedinaBibliography.4”
8) Thedocumentshouldhaveconsistentuseofterms.Forexample,theeditorshouldensurethateither‘palmprint’or‘palmprint’isusedthroughoutthedocument.
9) Acronymsshallbedefinedatfirstuseandshallappearinthesectionofthedocument“TermsandDefinitions”(SeeSection3.9).
10) Sectionsofthemainbodyofthestandardshallbedesignatedbyanumber.Subsectionsofthemainbodyofthestandardshallbedesignatedbyanumber,period,andanothernumber,repeatingasnecessarytoindicatethelevelofthesubsection.(Examplesare3.and3.1and3.1.8)Annexesshallbedesignatedbylettersandannexsectionsandsubsectionsshallbedesignatedbythatletterfollowedbyaperiodandasequenceofnumbersandperiodsdesignatingthelevel(s)ofthesubsection.(ExamplesareA.2andA.2.5andA.5.7.3)
3 DocumentLayoutforStandards
3.1. General
ThissectiondescribesthegeneralformatthatisusedforASBstandards.Deviationsfromthislayoutarepossible,butneedpriorapprovaloftheSecretariat.
3.2. CoverPage
ThecoverpageshallcontaintheASBnumericaldesignationforthestandardintheupperrightcorner.TheTitleshallbecenteredonthelinebelowtheASBnumericaldesignation.
ApictureorgraphicapprovedbytheASBstaffmaybeincludedonthecoverpage.
TheASBandANSIlogosshallnotappearonthedraftcopiesofthestandard,butshallbeaddedafterapprovalofthestandardbybothbodies.
4 ANSI, ANSI Style Guide‐Sheet‐2003, available for free at http://publicaa.ansi.org/sites/apdl/Documents/Standards%20Activities/American%20National%20Standards/Procedures,%20Guides,%20and%20Forms/New%20ANSI%20Style%20Guidesheet%202.doc
![Page 9: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/9.jpg)
ASBGuide0001‐2016
3
3.3. TitlePage
Thetitlepageimmediatelyfollowsthecoverpage.Likethecoverpage,itcontainstheASBnumericaldesignationofthestandardontheupperrightcornerofthepageandthecenteredtitlebelowit.
ThisisfollowedbytheASBandANSIapprovaldates.
TheASBlogo,printednameandaddressshallbeonthetitlepage.
Thefollowingshallappear:“Thisdocumentmaybedownloadedforfreeat:http://asb.aafs.org/.ItiscopyrightedbytheAmericanAcademyofForensicSciencesStandardsBoard,LLC.YEAR”
TheSecretariatwillassigntheISOInternationalClassificationforStandardsdesignation,whichimmediatelyfollowsthecopyrightstatement.
Keywords(nomorethanten)andashortabstract(twotothreesentences)shallappearatthebottomofthepage.
3.4. Foreword
TheForewordshoulddescribethestandardingeneralterms.
Next,theForewordshoulddescribehowthestandardoriginated(suchasbeingproposedbyaspecificSubcommitteeoftheOrganizationofScientificAreaCommitteessubmittingarequesttoASB).
Eachrevisionofthestandardshallincludeasummaryofthesubstantivechangestothepreviousedition.
3.5. Acknowledgements
(TheAcknowledgementssectionisoptional,theASB,theConsensusBoard,ortheWorkingGrouphavetheoptionoflistingnone,some,orallofthecategorieslistedbelow.)
Thissectionshouldbeorganizedasfollows:
Editor:
DeputyEditor(s):
DraftingWorkingGroupMembers:
ConsensusGroupMembers:
Aperson’snamemayappearundermorethanoneheading.Theconsensusgroupmembers(whoareeligibletovoteonthestandard)shallbeindicatedbytheperson’snameandorganizationthathe/sherepresents.Theinterestcategoryforeachmembershallbelisted.Thevotesofthemembersshallnotbeshowninthestandard.
![Page 10: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/10.jpg)
ASBGuide0001‐2016
4
Ifarevisiontothestandardismade,theoriginalacknowledgementsshallremaininthedocument,followedbyaheaderindicatingtheRevisionNumberandthesamesubheadingsaslistedabove.
3.6. TableofContents
TheTableofContentsshallincludeallofthesectionheaders,annexes,figuresandtables.Eachentryshallincludethepagenumber.Itisrecommendedthatthisbeautomaticallygeneratedbythewordprocessor.
3.7. Scope(Section1)
TheScopebeginswithaparagraphdescribingingeneraltermsthetypesofapplicationstargetedbythestandard.Asappropriatethescopealsoindicateswhatprocessesorapplicationsarenotcovered.Theparagraphshoulddefinethetargetaudience.
TheScopeisintendedtobebriefandconcise.
3.8. NormativeReferences(Section2)
Normativereferencesaredocumentsthatareindispensablefortheapplicationofthestandard.Fordatedreferences,onlytheeditioncitedapplies.Forundatedreferences,thelatesteditionofthereferenceddocument(includinganyamendments)applies.Normativereferencesshallbecitedatleastonceinthebodyofthestandard.
Thelistshallbeinalphabeticalorderofthedesignation(e.g.,ANSI/INCITS398)ornameoftheproducingorganizationorauthor,ifthereisnostandarddesignation(e.g.,AmericanBoardofForensicOdontology).Immediatelyfollowingisthenameofthedocumentinitalics.Informationabouthowtoobtainacopyofthedocumentshouldbeincluded,ifknown.
Sampleentriesare:
AmericanBoardofForensicOdontology,DiplomatesReferenceManual.Itisavailableathttp://www.abfo.org/resources/abfo‐manual/
ANSI/NIST‐ITL1‐2011Update:2015,NISTSpecialPublication500‐271V3,DataFormatfortheInterchangeofFingerprint,FacialandOtherBiometricInformation.Itisavailableathttp://www.nist.gov/itl/iad/ig/ansi_standard.cfm
3.9. TermsandDefinitions(Section3)
Anyacronymsorspecializedterminologyusedinthebodyofthestandardshallbelistedinthissection.Theyshallbenumberedandinalphabeticalorder,withspecialcharactersappearingfirst.Ifspecializedterminologyisusedinadefinition,thatterminologyshallhaveadefinitioninthissectionandthetermshallbeinboldletters.
Forpurposesofthisdocument,thefollowingdefinitionsandacronymsapply.
![Page 11: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/11.jpg)
ASBGuide0001‐2016
5
3.9.1BestPracticeRecommendationBPRABPRisbasedupontheconceptof“should”asopposedto“shall’.Itprovidesguidance.Althoughitisnotrequired,itisstillhighlyrecommendedthatasectionbeincludedaddressingthetechnicalandoperationalrationaleforspecificrecommendations.
3.9.2canUsedforstatementsofpossibilityorcapability(seeAnnexAforadditionalinformation).
3.9.3conditionalElementthepresenceofwhichinadocumentisdependentontheprovisionsoftheparticulardocument.
3.9.4 informativeElementthatidentifiesthedocument,introducesitscontentandexplainsitsbackground,itsdevelopment,anditsrelationshipwithotherdocuments.
Elementthatprovidesadditionalinformationintendedtoassisttheunderstandingoruseofthedocument.
3.9.5mandatoryElementthepresenceofwhichinadocumentisobligatory.
9.3.6mayUsedtoindicatethataprovisionisoptional(seeAnnexAforadditionalinformation).
9.3.7neednotUsedtoindicatethataprovisionisnotrequired(seeAnnexAforadditionalinformation).
3.9.8normativeElementthatdescribesthescopeofthedocumentorsetsoutprovisions.
3.9.9optionalElementthatisnotrequiredfortheimplementationofthedocument.
3.9.10recommendationExpressioninthecontentofadocumentconveyingthatamongseveralpossibilitiesoneisrecommendedasparticularlysuitable,withoutmentioningorexcludingothers,orthatacertaincourseofactionispreferredbutnotnecessarilyrequired,orthat(inthenegativeform)acertainpossibilityorcourseofactionisdeprecatedbutnotprohibited
![Page 12: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/12.jpg)
ASBGuide0001‐2016
6
3.9.11requirementExpressioninthecontentofadocumentconveyingcriteriatobefulfilledifcompliancewiththedocumentistobeclaimedandfromwhichnodeviationispermitted.
3.9.12shallUsedtoindicatethataprovisionismandatory(seeAnnexAforadditionalinformation).
3.9.13shouldUsedtoindicatethataprovisionisnotmandatory,butrecommendedasgoodpractice(seeAnnexAforadditionalinformation).
3.9.14StandardSDocument,establishedbyconsensusandapprovedbyarecognizedbody,thatprovides,forcommonandrepeateduse,rules,guidelines,orcharacteristicsforactivitiesortheirresults,aimedattheachievementoftheoptimumdegreeoforderinagivencontext.
3.9.15TechnicalReportTRATRdiffersfromastandardinthatitdoesnotrequireanything,itisanexplanatorydocument.ATRmaybeusedtodescribethescientificandoperationalunderpinningsofaStandard.
3.9.16statementExpressioninthecontentofadocumentconveyinginformation.
3.10. Requirements(Section4)
3.10.1. General
Thisisthe‘core’ofthestandard.Itislikelythatthissectionwillhaveseveralsubsections.Eachsectionandsubsectionshallhavedescriptivetext,whichmaycross‐referenceothersectionsofthestandard.Eachsectionorsubsectionshallclearlyindicatewhethertherequirementismandatory,optionalorconditional(dependentuponthevalueorcontentofanothersectionorsubsection).TheexactlayoutoftheRequirementswillvarybystandard,dependinguponthetopicbeingaddressed.
3.10.2. SubsequentNumbering
Allsubsequentheadingsshallbenumbered,andthetitleoftheheadingshallindicateifthesectionismandatory,optional,orconditional.
Paragraphsbelowasectionheadingmaybenumberedifitisanticipatedthatfuturereferences(inthedocument,orfromotherdocuments)maybemadetothatsection.
![Page 13: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/13.jpg)
ASBGuide0001‐2016
7
3.11. Conformance(Section5)
Thissectionspecifieswhattheconformityassessmentspecificationsareforthestandard.Itmayincludetestmethods,certifications,metricsorothercriteria.Theexactlayoutofthissectionwillvary,dependinguponthetopicbeingaddressed.Whenastandardisnotwrittentosupportconformityassessment,thestandardspecifiesthatcondition.
3.12. Annexes(LabeledAlphabeticallyinorder)
Annexescontainsupplementalinformation.Theymaybenormativeorinformativeandshallbeindicatedassuch,immediatelyafterthetitleoftheAnnexandinthetableofcontents.AllAnnexesshallbecalledoutinthetextofthedocument.
Normativeannexesgiveprovisionsadditionaltothoseinthebodyofthedocument.Theirpresenceisoptional.Anannex’snormativestatusshallbemadeclearbythewayinwhichitisreferredtointhetext.
Informativeannexesgiveadditionalinformationintendedtoassisttheunderstandingoruseofthedocument.Theirpresenceisoptional.Anannex’sinformativestatus(asopposedtonormative)shallbemadeclearbythewayinwhichitisreferredtointhetext.
Informativeannexesmaycontainoptionalrequirements.Forexample,atestmethodthatisoptionalmaycontainrequirementsbutthereisnoneedtocomplywiththeserequirementstoclaimcompliancewiththedocument.
ThefirstAnnexshallbeentitled“AnnexA–FoundationalPrinciples”.Itisinformative.ThisAnnexshallcontainadescriptionofthescientificandoperationalrationaleforthestandard.Ifthescientific/operationalbasisforthestandardisextensive,anASBTechnicalReport(TR)containingthatinformationshallbereferencedinthisAnnex.
ThelastannexcontainstheBibliography.TheBibliographyshallbeinformative(i.e.,thedocumentslistedarenotincludedinSection2oftheStandard).
4 FiguresandTables
Figuresandtablesshallbecalledoutinthedocumentandshouldbelocatedasclosetothecalloutaspossible.Figuresandtablesshallbedesignated“Table”or“Figure”andnumberedconsecutivelywithArabicnumerals,beginningwith1(e.g.,Table1,Table2,Figure1,Figure2).
Figureandtablesincludedinannexesshallincludetheidentifyingletteroftheannexinwhichtheyappear(e.g.,FigureA.1,TableB.1).
Figuresandtablesshallnotcontainrequirements.
5 DocumentLayoutforTechnicalReports
ATechnicalReportdiffersfromastandardinthatitdoesnotrequireanything.Itisexplanatory.ATechnicalReportmaybeusedtodescribethescientificandoperationalunderpinningsofaStandard.Thegeneraloutlineisthesame,butsinceaTechnicalReportdoesnothaverequirementsinit,therearenoNormativeReferences.ThecontentoftheTechnicalDiscussionsectionmaybe
![Page 14: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/14.jpg)
ASBGuide0001‐2016
8
organizedinamannerbestsuitedtothesubjectmatterunderdiscussion.ReferencesareinformationalandappearinaBibliography.
ThegeneraloutlineforanASBTechnicalReportis:
Coverpage
Titlepage
Foreword(describeshowtheTRoriginatedandanyrevisionstoit.ItshouldalsostateifthisTRprovidesthetechnicalandoperationalfoundationforastandard)
Acknowledgements
TableofContents
Scope(describeswhoisthetargetaudienceandwhattheTRcovers)
TermsandDefinitions
TechnicalDiscussion
Annexes
LastannexistheBibliography
6 DocumentLayoutforBestPracticeRecommendations
ABestPracticeRecommendationisbasedupontheconceptof‘should’asopposedto‘shall’.Itprovidesguidance.Althoughitisnotrequired,itisstillhighlyrecommendedthatasectionbeincludedaddressingthetechnicalandoperationalrationaleforspecificrecommendations.
ThegeneraloutlineforaBestPracticeRecommendationis:
Coverpage
Titlepage
Foreword(describeshowtheBPRoriginatedandanyrevisionstoit.)
Acknowledgements
TableofContents
Scope(describeswhoisthetargetaudienceandwhattheBPRcovers)
TermsandDefinitions
Recommendations
Annexes
LastannexistheBibliography
![Page 15: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/15.jpg)
ASBGuide0001‐2016
9
AnnexA(informative)
ExpressionofProvisions
A.1 Requirements
TableA.1summarizestheverbalformsofexpressionthatshallbeusedtoindicaterequirementstobefollowedinordertoconformtothedocumentandfromwhichnodeviationispermitted.
TableA.1—VerbalFormstoExpressRequirements
VerbalForm EquivalentExpressionsforUseinExceptionalCasesa
shallb istoisrequiredtoitisrequiredthathastoonly...ispermitteditisnecessary
shallnot isnotallowed(permitted)(acceptable)(permissible)isrequiredtobenotisrequiredthat...benotisnottobe
NOTE1Donotuse“may”when“can”ismeant.NOTE2Donotuse“maynot”when“shallnot”ismeant.NOTE3SeeISO/IECDirectives,Part2,AnnexGfornegativesoftheseverbalformsandfurtherexplanation.
aTheequivalentexpressionsgiventhesecondcolumnshallbeusedonlyinexceptionalcaseswhentheformgiveninthefirstcolumncannotbeusedforlinguisticreasons.bDonotuse“must”asanalternativefor“shall”(thiswillavoidanyconfusionbetweentherequirementsofadocumentandjurisdictionalregulatoryobligations).
Avoidusingvagueexpressionsthatarenottrulyinformativeandmightcausethereadertomakeanincorrect judgment call. Words like “very,” “all,” “every,” “never,” “excessive,” “slightly,”“approximately,”“nearly,”or“significant”arenotuseful.
A.2 Recommendations
TableA.2summarizestheverbalformsthatshallbeusedtoindicate:
a) that among several possibilities one is recommended as particularly suitable, withoutmentioningorexcludingtheothers;
b) orthatacertaincourseofactionispreferredbutnotnecessarilyrequired;
c) or that (in thenegative form)a certainpossibilityor courseof action is discouragedbutnotprohibited.
![Page 16: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/16.jpg)
ASBGuide0001‐2016
10
TableA.2—VerbalFormstoExpressRecommendations
VerbalForm EquivalentExpressionsforUseinExceptionalCasesa
should itisrecommendedthatoughtto
shouldnot itisnotrecommendedthatoughtnottoaTheequivalentexpressionsgiventhesecondcolumnshallbeusedonlyinexceptionalcaseswhentheformgiveninthefirstcolumncannotbeusedforlinguisticreasons.
A.3 Permission
TableA.3summarizestheverbalformsthatshallbeusedtoindicateacourseofactionpermissiblewithinthelimitsofthedocument.
TableA.3—VerbalFormstoExpressPermission
VerbalForm EquivalentExpressionsforUseinExceptionalCasesa
may ispermittedtoisallowedispermissible
neednot itisnotrequiredthatno...isrequired
Donotuse“possible”or“impossible”inthiscontext.Donotuse“can”insteadof“may”inthiscontext.
NOTE“May”signifiespermissionexpressedbythedocument,whereas“can”referstotheabilityofauserofthedocumentortoapossibilityopentohim/her.aTheequivalentexpressionsgiventhesecondcolumnshallbeusedonlyinexceptionalcaseswhentheformgiveninthefirstcolumncannotbeusedforlinguisticreasons.
A.4 PossibilityandCapability
TableA.4summarizestheverbalformsthatshallbeusedforstatementsofpossibilityandcapability,whethermaterial,physical,orcausal.
TableA.4—VerbalFormstoExpressPossibilityandCapability
VerbalForm EquivalentExpressionsforUseinExceptionalCasesa
can beabletothereisapossibilityofitispossibleto
cannot beunabletothereisnopossibilityofitisnotpossibleto
NOTESeeNoteinTableA.3.aTheequivalentexpressionsgiventhesecondcolumnshallbeusedonlyinexceptionalcaseswhentheformgiveninthefirstcolumncannotbeusedforlinguisticreasons.
![Page 17: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/17.jpg)
ASBGuide0001‐2016
11
AnnexB(normative)
PatentsandCopyrights
B.1 General
Participantsshallnotprovideanydocuments,data,orinformationiftheuseofsuchmaterialbytheASBinadocumentwouldinfringeupontherightsofanythirdpartiesintheinformationincluding,butnotlimitedto,copyrights,patents,tradesecrets,trademarks,publicity,andprivacy.ParticipantsshallnotifyASBstaffifaparticipantdeterminesthatanyinformationthatiscontainedinafinalordraftdocumentwouldviolatetherightsofthirdpartiesifpublishedbytheASB.
B.2 Patents
TheASBcomplieswiththePatentPolicyintheANSIEssentialRequirements‐2016.ThesubsectionsofSectionB.2aremodifiedfromthisdocumenttoreferspecificallytotheASB.
B.2.1InclusionofPatentsinAmericanNationalStandards
ThereisnoobjectioninprincipletodraftinganAmericanNationalStandard(ANS)intermsthat include the use of an essential patent claim (one whose use would be required forcompliancewiththatstandard)ifitisconsideredthattechnicalreasonsjustifythisapproach.
ParticipantsinANSI/ASBstandardsdevelopmentprocessareencouragedtobringpatentswithclaimsbelievedtobeessentialtotheattentionoftheASB.
IfASBreceivesanoticethataproposedANSoranapprovedANSmayrequiretheuseofsuchapatentclaim,thefollowingproceduresshallbefollowed.
B.2.2Statementfrompatentholder
TheASBshallreceivefromthepatentholderorapartyauthorizedtomakeassurancesonitsbehalf,inwrittenorelectronicform,either:
a) assuranceintheformofageneraldisclaimertotheeffectthatsuchpartydoesnotholdanddoesnotcurrentlyintendholdinganyessentialpatentclaim(s);or
b) assurance that a license to such essential patent claim(s) will be made available toapplicantsdesiringtoutilizethelicenseforthepurposeofimplementingthestandardeither:
i) under reasonable terms and conditions that are demonstrably free of any unfairdiscrimination;or
ii) without compensation and under reasonable terms and conditions that aredemonstrablyfreeofanyunfairdiscrimination.
Such assurance shall indicate that the patent holder (or third party authorized to makeassurancesonitsbehalf)will includeinanydocumentstransferringownershipofpatents
![Page 18: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/18.jpg)
ASBGuide0001‐2016
12
subject to the assurance, provisions sufficient to ensure that he commitments in theassurance are binding on the transferee, and that the transferee will similarly includeappropriate provisions in the event of future transfers with the goal of binding eachsuccessor‐in‐interest.
Theassuranceshallalsoindicatethatitisintendedtobebindingonsuccessors‐in‐interestregardlessofwhethersuchprovisionsareincludedintherelevanttransferdocuments.
B.2.3Recordofstatement
Arecordofthepatentholder’sstatementshallberetainedinthefilesofboththeASBandANSI.
B.2.3Notice
When theASBreceives fromapatentholder theassurance set forth inB.2.2.babove, thestandardshallincludeanotesubstantiallyasfollows:
NOTE–Theuser’sattentioniscalledtothepossibilitythatcompliancewiththisstandardmayrequireuseofaninventioncoveredbypatentrights.
Bypublicationofthisstandard,nopositionistakenwithrespecttothevalidityofanysuchclaim(s)orofanypatentrightsinconnectiontherewith.Ifapatentholderhasfileda statement of willingness to grant a license under these rights on reasonable andnondiscriminatorytermsandconditionstoapplicantsdesiringtoobtainsuchalicense,thendetailsmaybeobtainedfromthestandardsdeveloper.
3.1.4Responsibilityforidentifyingpatents
NeithertheASBnorANSIisresponsibleforidentifyingpatentsforwhichalicensemayberequiredbyanAmericanNationalStandardorforconductinginquiriesintothelegalvalidityorscopeofthosepatentsthatarebroughttotheirattention.
B.3 Copyrights
All ASB documents are protected by a variety of federal and state copyright laws, the followingdisclaimershallappearonallASBpublishedanddraftdocuments:
Allrightsreserved.Unlessotherwisespecified,nopartofthispublicationmaybereproducedorutilizedotherwiseinanyformorbyanymeans,electronicor
mechanical,includingphotocopying,orpostingontheinternetoronanintranet,withoutpriorwrittenpermissionfromtheAAFSStandardsBoard,AmericanAcademyofForensicSciences,410North21stStreet,ColoradoSprings,CO80904,asb.aafs.org.
Copyright©AAFSStandardsBoard[year]
Unless expressly agreed otherwise by the ASB, allmaterial and information that is provided byparticipantsandisincorporatedintoanASBdocumentisconsideredthesoleandexclusivepropertyoftheAAFSStandardsBoard.
IndividualsshallnotcopyordistributefinalordraftdocumentswithouttheauthorizationoftheASBstaff.
![Page 19: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/19.jpg)
ASBGuide0001‐2016
13
AnnexC(informative)
Numbers,UnitsofMeasurement,andEquations
C.1 UseofNumbers
Thefollowingaregeneralguidelinesfortheuseofnumbersintext.
Spell out numbers that are less than 10, not precise measurements, and not grouped withnumbersover10(eighttrials,FirstEdition).
Usenumeralsfornumbers10andabove,ornumbersunder10groupedwithnumbers10andabove(e.g.,from6to12cupsofwater,20thEdition).
Usenumeralsforexactstatisticalmeasures,scores,samplesizes,andsums(multipliedby3,or5%ofthesample).
UsecombinationsofwrittenandArabicnumeralsforback‐to‐backnumbers(five4‐pointscales).
Usecombinationsofnumeralsandwrittennumbersforlargesums(over6millionpeople).
Useacommainnumbersthatare≥10,000(7000items,11,200units).
Usethepercentsymbol(%)onlywithfigures(6%),notwithwrittennumbers(sixpercent).
Donotuseperiodswithinmeasurements(lb,ft,s)exceptinches(in.).
C.2 UnitsofMeasurement
InrecognitionofbroaduseandapplicabilityofASBstandards,measuredandcalculatedvaluesmaybeexpressed inmetricunits(SI)andU.S.customaryunits(USC).Whencitingunits indualunits,eitherunitmaybelistedfirstwiththecorrespondingunitlistedeitherinparenthesesinthetextoron separate, tables, figures, datasheets or in separate annexes. Units shall be listed consistentlywithinadocument.
C.3 Equations
Equationsshouldbenumberedwhentwoormoreareincludedinthemaintextofthedocument.DesignateequationswithconsecutiveArabicnumbersbeginningwith1.Numbereachequationintheorderthatitappearsinthestandard,regardlessofthesectionnumberinwhichitisreferenced.Designateequationsinannexesbythedesignationoftheannexfollowedbyconsecutivenumbersbeginningwith1(forexample,A.1,B.4).
Theformatforanumberedequationis:
(1)
where:
![Page 20: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/20.jpg)
ASBGuide0001‐2016
14
S =stress,psiorPa,
M =bendingmoment,lbf•in.orN•m,
c =distancefromneutralaxistooutermostfiber,in.,orm,and
I =secondmomentofarea,in.4orm4.
![Page 21: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/21.jpg)
ASBGuide0001‐2016
15
AnnexD(informative)
SampleFormatforanASBDocument
1 Scope
ThisManualwasdevelopedtoprovideguidanceforpreparingdocumentsthatwillbepublishedbytheAcademyStandardsBoard(ASB)andsubmittedtotheAmericanNationalStandardsInstitute(ANSI).
2 NormativeReferences
Thefollowingreferenceddocumentsareindispensablefortheapplicationofthisdocument.Fordatedreferences,onlytheeditioncitedapplies.Forundatedreferences,thelatesteditionofthereferenceddocument(includinganyamendments)applies.
ANSIStyleGuide‐Sheet‐20035
HowtoWriteStandards,InternationalOrganizationforStandardization(ISO)6
ANSI/SES1:2013,RecommendedPracticefortheDesignationandOrganizationofStandards,TheSocietyforStandardsProfessionals(SES)7
3 TermsandDefinitions
Forpurposesofthisdocument,thefollowingdefinitionsandacronymsapply.
3.1termDefinition.
3.2termacronymDefinition.
4 Level1Heading[Cambriafont,12pt,bold,12ptspacebelow]
4.1 Level2additionalHeading[Cambriafont,11pt,bold,12ptspacebelow]
Documenttext[Cambriafont,11pt,12ptspacebelow].
5TheANSIStyleGuide‐Sheet‐2003isavailableforfreeathttp://publicaa.ansi.org/sites/apdl/Documents/Standards%20Activities/American%20National%20Standards/Procedures,%20Guides,%20and%20Forms/New%20ANSI%20Style%20Guidesheet%202.docv6HowtoWriteStandardsisavailableforfreeatwww.iso.org/iso/how‐to‐write‐standards.pdf7ANSI/SES1:2013,RecommendedPracticefortheDesignationandOrganizationofStandardsisavailableforafeeatwww.ses‐standards.org
![Page 22: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/22.jpg)
ASBGuide0001‐2016
16
a) Firstleveloflistsarealphabetical,consistentfontwithtextleadingintothelist.
b) Listsarealsoseparatedbya12ptspacebeloweachitem.
i) SecondleveloflistsareRomannumerals,fontandspacingconsistentwiththelead‐inlist.
NOTE[Cambriafont,10pt]
EXAMPLE[Cambriafont,11pt].
CAUTION[Cambriafont,11pt,bold].
5 Tables
Tablesshallbecalledoutinthetext,andshallbenumberedsequentiallythroughthedocument.Tablesinannexesshallbenumberedsequentiallythrougheachannexwiththeannexletterastheprefixtothetablenumber.
Table1–TableTitle[Cambriafont,11pt,bold,centered,abovethetable]
TableHeaderRow [Cambriafont,10pt,bold]
Tablecontent [Cambriafont,10pt,centeredifappropriate,alltablecontenthas2
ptaboveandbelow]
Tablenotesorfootnotes[Cambriafont,9pt]
6 Figures
Figuresshallbecalledoutinthetext,andshallbenumberedsequentiallythroughthedocument.Figuresinannexesshallbenumberedsequentiallythrougheachannexwiththeannexletterastheprefixtothefigurenumber.
Figure1–FigureTitle[Cambriafont,11pt,bold,centered,belowthefigure]
![Page 23: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/23.jpg)
ASBGuide0001‐2016
17
7 Annexes
Annexesshallalwaysstartatthetopofanewpageandshallbecalledoutinthemainbodyofthedocument.
AnnexX[Cambriafont,14pt,bold,centered,nospacebelow]
(informativeornormative)[Cambriafont,14pt,centered,12ptbelow]
AnnexTitle[Cambriafont,14pt,bold,centered,12ptbelow]
X.1 Level1AnnexHeader[Cambriafont,12pt,bold,12ptbelow]
X.1.2 Level2AnnexadditionalHeading[Cambriafont,11pt,bold,12ptspacebelow]
Annextext[Cambriafont,11pt,12ptspacebelow].
8 Bibliography
ThelastannexcontainstheBibliography.TheBibliographyshallbeinformative(i.e.,thedocumentslistedarenotincludedinSection2,NormativeReferences,oftheStandard).
![Page 24: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/24.jpg)
ASBGuide0001‐2016
18
AnnexE(informative)
Bibliography
1] ASTMInternational,FormandStyleforASTMStandards,January20158
2] IEEEStandardsAssociation,2014IEEE‐SAStandardsStyleManua9
3] ISO/IECDirectives,Part2,RulesforthestructureanddraftingofInternationalStandards,201110
4] NFPA,ManualofStyleforNFPATechnicalCommitteeDocuments,July200411
8ASTMInternational,100BarrHarborDrive,POBoxC700,WestConshohocken,PA19428‐29599IEEE,3ParkAvenue,17thFloor,NewYork,NY,10016‐599710InternationalOrganizationforStandardization,1,ch.delaVoie‐Creuse,Casepostale56,CH‐1211Geneva2011NationalFireProtectionAssociation,1BatterymarchPark,Quincy,MA02169‐7471
![Page 25: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/25.jpg)
![Page 26: ASB Style Guide Manual for Standards, Technical and Best ... · ASB Style Guide Manual for Standards, Technical Reports and Best Practice Recommendations – 2016 Edition 1 Preface](https://reader030.fdocuments.net/reader030/viewer/2022040117/5dd0dd77d6be591ccb631372/html5/thumbnails/26.jpg)
AcademyStandardsBoard4200WisconsinAvenue,NW
Suite106‐310Washington,DC20016‐2143
http://asb.aafs.org/