Hi Mark,
Thanks for the suggestions. These are indeed helpful.
In 802.11be, the editor provides a guide for specification drafting.
https://mentor.ieee.org/802.11/dcn/20/11-20-1250-00-00be-a-guide-for-specification-drafting.ppt
I probably will do similar things later in 802.11bn.
To all volunteers,
Meanwhile, we have 802.11 Editorial Style Guide. Please take a look:
https://mentor.ieee.org/802.11/dcn/09/11-09-1034-21-0000-802-11-editorial-style-guide.docx
Regards
Ross Jian Yu
于健
Huawei Technologies
发件人: Mark Rison <m.rison@xxxxxxxxxxx>
发送时间: 2024年10月22日 3:36
收件人: STDS-802-11-TGBN@xxxxxxxxxxxxxxxxx
主题: Re: [STDS-802-11-TGBN] Initial draft of TGbn Guidelines
Could I suggest that something along the following lines be added to section 4?
When writing draft text, to avoid wasting time later on comments that could easily have been avoided:
- Make sure you refer to frames/fields/etc. by their actual name. Don't abbreviate or otherwise fiddle with the name. Remember frames/fields/etc. have exactly one name.
If a field gets renamed, check your text for any references to that field and update them
- Make sure you refer to MIB variables/tables that actually exist (i.e. have a definition in Subannex C.3)
- Make sure each word in frame/field/etc. names starts with an uppercase letter (but check the rules for hyphenated words)
- In Clause 9, do not give field/etc. sizes in text if already given in a figure
- In Clause 9, do not say fields contain little-endian/unsigned/etc. integers (since this is the default per 9.2.2)
- In Subclause 9.4.2 etc., follow the most common template for the structure of a new subclause
- Do not duplicate in Clause != 9 format/encoding information given in Clause 9
- Do not put behaviour in Clause 9
- Make sure you don't forget articles (the/a/an), but also make sure you don't include articles for uncountable nouns (or pluralise them!). If your native language doesn't
have articles, ask a colleague whose native language does to proof-read
[Do feel free to add to this!]
Thanks,
Mark
--
Mark RISON, Standards Architect, WLAN English/Esperanto/Français
Samsung Cambridge Solution Centre Tel: +44 1223 434600
1 Cambridge Square, Cambridge CB4 0AE Fax: +44 1223 434601
ROYAUME UNI WWW:
http://www.samsung.com/uk
From: Alfred Asterjadhi <asterjadhi@xxxxxxxxx>
Sent: Thursday, 10 October 2024 02:15
To: STDS-802-11-TGBN@xxxxxxxxxxxxxxxxx
Subject: [STDS-802-11-TGBN] Initial draft of TGbn Guidelines
Hello all,
I posted
https://mentor.ieee.org/802.11/dcn/24/11-24-1682-00-00bn-tgbn-guidelines.docx which contains an initial draft of the guidelines for TGbn. Most of them are inherited from 11be guidelines (some new parts i have used bold font for ease of identification.
Please take a look at them and let me know of any suggestions and/or feedback.
I also plan to quickly go over some parts of the guidelines during the Joint conf call tomorrow (in particular the item that discusses the preparatory phase for D0.1 since we are getting near to that milestone, and possibly
the new parts which account for received suggestions with the intent of further improving our MO).
Regards,
Alfred
--
Alfred Asterjadhi, PhD
IEEE802.11 TGbe/TGbn Chair,
Qualcomm Technologies Inc.
Cell #: +1 858 263 9445
Office #: +1 858 658 5302
To unsubscribe from the STDS-802-11-TGBN list, click the following link:
https://listserv.ieee.org/cgi-bin/wa?SUBED1=STDS-802-11-TGBN&A=1
|
|
To unsubscribe from the STDS-802-11-TGBN list, click the following link:
https://listserv.ieee.org/cgi-bin/wa?SUBED1=STDS-802-11-TGBN&A=1
To unsubscribe from the STDS-802-11-TGBN list, click the following link: https://listserv.ieee.org/cgi-bin/wa?SUBED1=STDS-802-11-TGBN&A=1