Theory and Justification

From APIDesign

(Difference between revisions)
Jump to: navigation, search
Current revision (05:28, 29 July 2018) (edit) (undo)
 
(2 intermediate revisions not shown.)
Line 1: Line 1:
-
"In that case, developers using it will
+
Part 1 of the [[TheAPIBook]] is dedicated to [[Theory and Justification]].
-
create a feeling way different that conflicts with
+
-
the architect's intentions." does not make such sense.
+
-
--[[User:JesseGlick|JesseGlick]] 03:44, 25 March 2008 (UTC)
+
* Chapter 1: [[The Art of Building Modern Software]]
 +
* Chapter 2: [[The Motivation to Create an API]]
 +
* Chapter 3: [[Determining What Makes a Good API]]
 +
* Chapter 4: [[Ever Changing Targets]]
-
* There are no page numbers on this section
+
These observations are still valid even [[TenYears]] after [[TheAPIBook]] publication.
-
* Punc: Para 2: Delete comma after API - it's not necessary
+
-
* Content: Para 2: This is the perfect place to hint at some counter-examples of consistency in Java... unfortunately, I'm having some trouble coming up with examples right now! (things like A.size(), B.size(), C.getSize(), or A.toInt(), B.toInt(), C.getInt() or something)
+
-
* Spacing: Para "A Stable API" - is there an extra space before "API is stable" in italics?
+
-
* References: Para "If you believe" - "Part __" missing Part numbers (twice).
+
-
--[[User:Dmkoelle|Dmkoelle]] 20:50, 26 March 2008 (UTC)
+
-
 
+
-
* I agree with Jesse's comment that the last sentence in the first paragraph doesn't make sense. I'd perhaps suggest "In that case, developers will use it in a way that conflicts with the architect's intentions".
+
-
* (wording) para 1: "the API architect is an artist..." => "the API architect is either an artist..."
+
-
* (wording) para 2: "the API users" => "the API's users"
+
-
* (spelling) first page, last paragraph: "deja vu" => "déjà vu"
+
-
--[[User:AdamDingle|AdamDingle]] 22:57, 27 March 2008 (UTC)
+
-
 
+
-
* "I found proof this a year later" should be "I found proof of this a year later"
+
-
--[[User:TomWheeler|TomWheeler]] Thu Mar 27 21:16:22 CDT 2008
+
-
 
+
-
* If the anecdote in "Design By Committee" refers to xml-tree, then that external developer was me, soon after university and very green on APIs :-)
+
-
--[[User:RichUnger|RichUnger]] Thu Mar 27 20:28:22 CDT 2008
+

Current revision

Part 1 of the TheAPIBook is dedicated to Theory and Justification.

These observations are still valid even TenYears after TheAPIBook publication.

Personal tools
buy