[ibis-editorial] IBIS draft 5.1-draft-v01 Initial Review
- From: "Bob Ross" <bob@xxxxxxxxxxxxx>
- To: <ibis-editorial@xxxxxxxxxxxxx>
- Date: Fri, 8 Jul 2011 00:59:29 -0700
Editorial Group:
Attached are my review comments - global and specific.
Some of the comments are the same or are similar to
Arpad's comments.
Also we can break up the review with multiple global passes
on the complete document or on some unique sections
(sorry if there are redundant points):
FULL DOCUMENT PASSES
Final Format issues Pass
Sections Upper Case, Arial 14??
Figure Pass
- Add All captions
- Revise figures to remove Captions
- Cropping where needed
Figure numbers aligned to Sections, or just continuous
dynamic links. Tables numbers aligned to Sections pass??
Yellow Dynamic Link and yellow re-direction pass??
Format correction pass
Table line spacing
Some Table Captions inside the table (e.g. Table 5 vs. Table 4.)
list 1-1/2 to 1 LF spacing
Know Issues Pass for V5.0
Tree Diagram Insertion Pass
Certain character groupings pass (allowed characters)
Deal with Tables and Figures split over two pages.
Section 6a Format Pass
Top-Level: - Bold Arial 12 (and Upper Case?? - no)
Submodel: - Bold Arial 12 (and Upper Case)
(Dynamic Clamp: Bus Hold: and Fall Back: are Bold, Arial 12.)
Merge several tables on one page.
Section 6b Format Pass
Definitions, pg 102 Put into a Table??
Definitions: Bold Arial 12
General Assumptions: Bold Arial 12
Review all titles, subtitles since original document
had some indentations, double spaces and other visual
differences that are not captured or apparent.
E.g., Pg. 110, both are New Times Roman 12 below
Subparameter Definitions:
Language:
multiple Examples in Courier review
Section 7 Format Pass
Subsection Font headings - Arial 12 Bold
Sections 8, 9, 11 Format Passes
(Sometime upper case distinctions in subheadings
in V5.0 converted to mixed case heading in V5.1-draft
cause hard to read confusion.)
Lou Church readme Pass
Bob
--
Bob Ross
Teraspeed Consulting Group, LCC
http://www.teraspeed.com
bob@xxxxxxxxxxxxxx
Direct : 503-246-8048
Teraspeed Labs: 503-430-1065
Headquarters: 401-284-1827
Teraspeed is a registered service mark of Teraspeed Consulting Group LLC
All:
Here are some review comments on the draft of IBIS
Version 5.1 (minus the IBIS-AMI sections).
General Comments, Conventions:
1. I prefer Arial 14 (vs. Aerial 12) for top-level sections
due to other Arial 12 headings inside the section.
2. We should make them Upper Case like in IBIS Version 5.0.
Some references such as "NOTES ON DATA DERIVATION METHOD"
are in upper case.
3. I assume we are keeping the existing Section numbers
4. All yellowed Section links need to be made dynamic??
5. All other yellowed "above/below/last section/item 10 above, etc."
or named sections need to be reviewed and possibly revised.
6. Should figure numbers, table numbers and equation numbers (if given)
be linked to section numbers? E.g., Figure 6c.1
7. Should lists of information be separated from the paragraph by
a line feed? (See Pg. 4 list of characters versus pg. 12 list of
characters.) Also see item 7. in specific comments below.
8. Should Table caption be on Top or bottom and 2 linefeeds away?
(e.g. Table 2 on pg 48)
9. Missing Captions, e.g., Figure 1.
10. Remove Text figures when Visio picture approved.
11 Figure Cropping, removal of captions, adding of
captions where missing or unknown pass
Pg. 33, 35, 38, 40, etc.
Crop Figures 3, 4, 5, 6. 7, 8,
Remove embedded caption since it is duplicated.
Add captions where indicated
12. Table Caption additions throughout.
Specific Comments
1. Pg. 4. item 3. The table should be in Courier New 10
like on Pg. 12. Why in Courier New 10 are the single quote
mark ' different. The Pg. 4 one is the left ', while the
Pg. 12 version is just a vertical '?
2. Pg. 4: Line feed separations between item numbers is not
consistent. It appears to vary between 1, 1-1/2. Recommend
at least 1-1/2 and possibly 2 (as in V5.0) for all items
3. Pg. 4. Other formatting items (font, linefeeds, tabs)
might be reviewed for items 2 and 8
4. Pg. 6: Section "3.1" should be Section "3a"
5. Pg 12: [Comment Char] list of characters should be indented
by one tab - same as in Section 3, item 3.
6. pg 13: File Rev] --> [File Rev]
7. Pg 18 lists of length limits - 2 -spaces look too spreadout.
(This is also Arpad's comment.) I think we should review all of this
and set a consistent standard.
8. Pg 25 - Correct the fonts for the line: Keyword: [Model]
9. Pg. 28, 29: Figures 1, 2 - the box around the drivers are removed. The
boxes can indicate that the timing test load setup can include
the package model, (e.g., Timing_location Pin) So the timing
test load connection can be at the "Die" or "Pin" as in V5.0. It is
not only just an ideal buffer test.
10. Pg. 49: Refer to Notes on Data Derivation Method"
The section title should be upper case per V5.0 and consistency.
11 .Pg. 50 Yellowed "Other Notes" should be in italics.
12. Pg 61, 62 Equation variable "0" is not italicized.
13. Pag 66, Figure 13. Make the device a true box without
extended left, right borders.
14. pg 69, Figure 14 - make the box part look more like
two MOSFETs in parallel, and the pin1, pin2 terminals horizontally
centered. (correction to be discussed)
15. Pg 72 dv --> dV
16: Pg 91 - Add Italic Example: above the Example
17. pg. 102 - Definitions: Arial 12 Bold
(Put definitions in Table??)
18 pg 109 Keyword Definitions: Arial 12 Bold
19 pg. 117 Figure 26: Remove Figure 8 caption inside the figure.
20 pg. 118 Figure 27: Remove Figure 9 caption inside the figure
21 pg. 123 - put Courier |-------- above | Example .... entry
to be parallel with the entry on pg. 124
(or we look at the overall format for Section 6b. for multiple
examples)
22 pg. 139 Fiure 30 has Figure 12 Caption inside the figure
23 pg 55 7 Package Modeling| --> 7 Package Modeling
24 pg. 155: Case differences of "note" in Table 15
25 pg. 156 Usage Rules for the .pkg File - Arial 12 bold,
and .pkg is lower case by revised convention not honoring
V5.0 upper case headings.
26. pg. 160: Single-space before See Figure 31 - add space
before new sentence since convention throughout is 2 spaces.
27. pg 161: RLC Matrix Notes: Arial 12 Bold
28 pg. 164 - [Define Packae Model] My_Model Courier 10 Font??
Review
29 pg. 165 - Package Model Example Arial 12 Bold
Also, italic Example: might be removed since this is not a
keyword description
30 pg. 168 Usage Rules: and Contents: should be Arial 12 Bold
31 pg. 175 Figure 34 Remove A5 <----- line
32 pg 177: Method| ---> Method on title line
33 pg 195 Parameters| ---> Parameters in the title
34 pg 196 Line feed before C_Heatsink_Float line (mistake in
V5.0)
Later Additions/Fixes
1. Title Page and Table of Contents
2. Section 2, Version 5.1 update writeup
3. All Tree diagrams.
4. Change all example dates, Versions to the new year
and date and version of ratification. For example
[Date] August 29, 2008 to the current date.
Also for some version references, e.g. in .pkg,
[IBIS Ver] 5.1
5.Fixes from Ver5.0 known_issues document
Other related posts:
- » [ibis-editorial] IBIS draft 5.1-draft-v01 Initial Review - Bob Ross
