You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _data/glossary.yml
+1-1
Original file line number
Diff line number
Diff line change
@@ -253,7 +253,7 @@ swagger:
253
253
254
254
swagger_codegen:
255
255
term: Swagger Codegen
256
-
def: "Generates client SDK code for a lot of different platforms (such as Java, JavaScript, Scala, Python, PHP, Ruby, Scala, and more). The client SDK code helps developers integrate your API on a specific platform and provides for more robust implementations that might include more scaling, threading, and other necessary code. In general, SDKs are toolkits for implementing the requests made with an API. Swagger Codegen generates the client SDKs in nearly every programming language. See [Swagger Codegen](https://swagger.io/swagger-codegen/) for more information. See also [SDKs](docapis_sdks.html)."
256
+
def: "Generates client SDK code for a lot of different platforms (such as Java, JavaScript, Scala, Python, PHP, Ruby, Scala, and more). The client SDK code helps developers integrate your API on a specific platform and provides for more robust implementations that might include more scaling, threading, and other necessary code. In general, SDKs are toolkits for implementing the requests made with an API. Swagger Codegen generates the client SDKs in nearly every programming language. See [Swagger Codegen](https://swagger.io/swagger-codegen/) for more information. See also [SDKs](https://idratherbewriting.com/learnapidoc/docapis_sdks.html)."
Copy file name to clipboardExpand all lines: _data/quality_checklist.yml
+16-16
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ relevance:
72
72
priority: high
73
73
74
74
- title: Code samples exist
75
-
description: "<a href='docapis_codesamples_bestpractices.html'>Code samples</a> showing sample ways to use the API (or similar tools) are provided. Ideally, the code samples are available in the user's target language. This might mean providing multiple code samples."
75
+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_codesamples_bestpractices.html'>Code samples</a> showing sample ways to use the API (or similar tools) are provided. Ideally, the code samples are available in the user's target language. This might mean providing multiple code samples."
description: "The <a href='docapis_doc_overview.html'>overview</a> explains the big picture and describes the problem that the tool or service addresses. Common who/what/where/why questions are answered here."
96
+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_overview.html'>overview</a> explains the big picture and describes the problem that the tool or service addresses. Common who/what/where/why questions are answered here."
97
97
priority: high
98
98
99
99
- title: Access and authorization explained
100
100
description: "Details about how to get access, permissions, and authorization to use the API are provided. For example, this topic might cover how to authorize an API call with API keys."
101
101
priority: high
102
102
103
103
- title: Overview addresses use cases
104
-
description: "The <a href='docapis_doc_overview.html'>overview</a> provides a high-level description of the main use cases or business objectives of the product. This allows users to get a sense of what the API is all about."
104
+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_overview.html'>overview</a> provides a high-level description of the main use cases or business objectives of the product. This allows users to get a sense of what the API is all about."
105
105
106
106
- title: Overview has architectural diagram and explanation
107
-
description: "The <a href='docapis_doc_overview.html'>overview</a> has a diagram of the main components and how they interact. This provides users with a glimpse of the whole."
107
+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_overview.html'>overview</a> has a diagram of the main components and how they interact. This provides users with a glimpse of the whole."
108
108
109
109
- title: Overview has index of assets that the product offers
110
110
description: "If there's an SDK or developer kit that users can download, the contents of this download are described. This is similar to product instructions that start by identifying all parts that should have arrived in a package."
@@ -113,7 +113,7 @@ clarity:
113
113
description: "For larger systems that might have multiple subsystems (e.g., groups of APIs for different scenarios), these subsystems have their own landing pages that resemble the higher-level overview (with use cases, diagrams, getting started links) but scoped to that specific subsystem."
114
114
115
115
- title: Getting started tutorial exists
116
-
description: "A <a href='docapis_doc_getting_started_section.html'>getting started tutorial</a> is provided for users to get started in an end-to-end way with the product, producing a sample output that builds their confidence. This topic might provide info on how to sign up, register, get API keys or permissions, and start using the API. (This topic might link to the authorization topic but is more comprehensive in scope. The purpose of this topic is frictionless onboarding.)"
116
+
description: "A <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_getting_started_section.html'>getting started tutorial</a> is provided for users to get started in an end-to-end way with the product, producing a sample output that builds their confidence. This topic might provide info on how to sign up, register, get API keys or permissions, and start using the API. (This topic might link to the authorization topic but is more comprehensive in scope. The purpose of this topic is frictionless onboarding.)"
117
117
118
118
- title: Sandbox environment available
119
119
description: "A sandbox environment is available for users to try out the tool/system/API on their own and get a better understanding of how it works."
@@ -128,10 +128,10 @@ clarity:
128
128
description: "Tasks are articulated through a series of specific, usually numbered steps or sections that reduce the complexity of the task. More complex tasks might require more granular and numerous steps or sections so as to reduce the complexity. (This is the primary way that technical writers simplify complexity.)"
129
129
130
130
- title: Sample app available
131
-
description: "In more robust docs, a <a href='docapis_sample_apps.html'>sample app</a> might serve as a reference implementation for users."
131
+
description: "In more robust docs, a <a href='https://idratherbewriting.com/learnapidoc/docapis_sample_apps.html'>sample app</a> might serve as a reference implementation for users."
132
132
133
133
- title: Code sample has inline comments
134
-
description: "<a href='docapis_codesamples_bestpractices.html'>Code samples</a> are appropriately commented, either with inline comments, comments that preface or follow the sample, or both. Long code samples with no explanation aren't just dropped in."
134
+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_codesamples_bestpractices.html'>Code samples</a> are appropriately commented, either with inline comments, comments that preface or follow the sample, or both. Long code samples with no explanation aren't just dropped in."
135
135
136
136
- title: Any role-based permissions are noted
137
137
description: "If there are different roles and permission levels that correspond to varying capabilities, these roles are noted in all places they apply, such as within the individual API reference. For example, if only admin roles can use a certain endpoint, this is noted in the endpoint's reference and in any places that use the endpoint."
@@ -140,7 +140,7 @@ clarity:
140
140
description: "Specific steps for completing tasks are described in detail rather than glossed over in general ways — unless the task is something the audience is already familiar with. Overall, the documentation strikes a balance between providing enough detail for users to get the job done but not including too much detail that the reader is inundated with extraneous information."
141
141
142
142
- title: Workflow maps connect topics in larger flows
143
-
description: "Larger tasks that span multiple topics have a <a href='/simplifying-complexity/macro-micro.html'>workflow map</a> (or similar mechanism) that connects the topics together."
143
+
description: "Larger tasks that span multiple topics have a <a href='https://idratherbewriting.com/learnapidoc/simplifying-complexity/macro-micro.html'>workflow map</a> (or similar mechanism) that connects the topics together."
144
144
145
145
- title: Visuals aid in areas of confusion
146
146
description: "In places that are particularly confusing, appropriate visuals or additional examples have been added to reduce confusion."
@@ -163,33 +163,33 @@ clarity:
163
163
completeness:
164
164
165
165
- title: Reference docs follow industry standards
166
-
description: "For native library APIs (or other API types), reference docs (auto-generated from source code comments) are available. This might mean <a href='nativelibraryapis_exploring_javadoc_output.html'>Javadoc</a>, <a href='nativelibraryapis_doxygen.html'>Doxygen</a>, <a href='pubapis_openapi_intro.html'>OpenAPI</a> outputs like <a href='pubapis_swagger.html'>Swagger</a> or other reference docs specific to the library. The reference docs should be populated and generally follow tagging standards."
166
+
description: "For native library APIs (or other API types), reference docs (auto-generated from source code comments) are available. This might mean <a href='https://idratherbewriting.com/learnapidoc/nativelibraryapis_exploring_javadoc_output.html'>Javadoc</a>, <a href='https://idratherbewriting.com/learnapidoc/nativelibraryapis_doxygen.html'>Doxygen</a>, <a href='https://idratherbewriting.com/learnapidoc/pubapis_openapi_intro.html'>OpenAPI</a> outputs like <a href='https://idratherbewriting.com/learnapidoc/pubapis_swagger.html'>Swagger</a> or other reference docs specific to the library. The reference docs should be populated and generally follow tagging standards."
167
167
priority: high
168
168
169
169
- title: Parameter docs have complete info
170
-
description: "<a href='docapis_doc_parameters.html'>Parameter documentation</a> typically includes a description, data type, min/max values, sample values, and optional/required usage."
170
+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_doc_parameters.html'>Parameter documentation</a> typically includes a description, data type, min/max values, sample values, and optional/required usage."
171
171
priority: high
172
172
173
173
- title: Reference content has consistent structure
174
-
description: "Reference material such as APIs follow a <a href='docapis_api_reference_tutorial_overview.html'>common structure within each topic</a>, mostly following a request-response type structure. Typical sections include descriptions, parameters, sample requests or usage, and sample responses."
174
+
description: "Reference material such as APIs follow a <a href='https://idratherbewriting.com/learnapidoc/docapis_api_reference_tutorial_overview.html'>common structure within each topic</a>, mostly following a request-response type structure. Typical sections include descriptions, parameters, sample requests or usage, and sample responses."
175
175
176
176
- title: Error messages are documented
177
-
description: "<a href='docapis_doc_status_codes.html'>Error messages</a> that users can encounter are documented and discoverable through search. This supports the <a href='docapiscode_research_on_documenting_code.html#systematic_vs_opportunistic'>opportunistic/experiential user behavior</a>."
177
+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_doc_status_codes.html'>Error messages</a> that users can encounter are documented and discoverable through search. This supports the <a href='https://idratherbewriting.com/learnapidoc/docapiscode_research_on_documenting_code.html#systematic_vs_opportunistic'>opportunistic/experiential user behavior</a>."
178
178
179
179
- title: Responses includes both sample and schema (REST APIs)
180
-
description: "The <a href='docapis_doc_sample_responses_and_schema.html'>response documentation</a> for REST APIs provides both a sample response and schema. The response provides an example of what might be returned, while the schema defines all possible elements that might be returned and describes attributes such as data types and whether the elements are required or optional in the response."
180
+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_sample_responses_and_schema.html'>response documentation</a> for REST APIs provides both a sample response and schema. The response provides an example of what might be returned, while the schema defines all possible elements that might be returned and describes attributes such as data types and whether the elements are required or optional in the response."
181
181
182
182
- title: Troubleshooting section exists
183
183
description: "The documentation has a troubleshooting section (either standalone or included within the section/topic it relates to) that provides information on how to solve common problems. The troubleshooting information indicates where things might go wrong and how to fix them. In other words, the documentation doesn't just describe the happy path."
184
184
185
185
- title: Limitations/thresholds documented
186
-
description: "If there are <a href='docapis_rate_limiting_and_thresholds.html'>limitations and thresholds</a> (for example, max number of API calls, max file sizes, max string lengths, max/min parameter values, max server load), these limitations are called out in the docs."
186
+
description: "If there are <a href='https://idratherbewriting.com/learnapidoc/docapis_rate_limiting_and_thresholds.html'>limitations and thresholds</a> (for example, max number of API calls, max file sizes, max string lengths, max/min parameter values, max server load), these limitations are called out in the docs."
187
187
188
188
- title: Locale limitations noted
189
189
description: "If a feature is available only in certain contexts (locales, languages, platforms, roles, versions), that information is noted clearly in the feature. For example, an API that is only available for enterprise versions might have a label that says \"Enterprise Version Only,\" or if only available for a particular platform, might say \"Linux Only\" or the equivalent."
190
190
191
191
- title: Unhappy paths are documented
192
-
description: "If there are pitfalls or other traps, gaps, and gotchas to avoid, these are noted in the documentation rather than hidden from the user. A section called <a href='/2010/12/16/known-limitations/'>Known Limitations</a> often contains this information. The documentation doesn't lie or mislead the user but rather is <a href='/2017/07/13/transparency-in-documentation/'>transparent, honest, and helpful</a> even if it means exposing the product's warts and revealing problems users will like encounter."
192
+
description: "If there are pitfalls or other traps, gaps, and gotchas to avoid, these are noted in the documentation rather than hidden from the user. A section called <a href='https://idratherbewriting.com/learnapidoc/2010/12/16/known-limitations/'>Known Limitations</a> often contains this information. The documentation doesn't lie or mislead the user but rather is <a href='https://idratherbewriting.com/learnapidoc/2017/07/13/transparency-in-documentation/'>transparent, honest, and helpful</a> even if it means exposing the product's warts and revealing problems users will like encounter."
193
193
194
194
readability:
195
195
@@ -220,7 +220,7 @@ readability:
220
220
description: "Each topic usually has a <a href='https://idratherbewriting.com/2018/09/15/pages-at-a-glance-feature/#enforcing-best-practices-with-structure'>short summary below the title</a> that encapsulates the main purpose of the topic. This helps users get a sense of the topic at a glance."
221
221
222
222
- title: Glossary exists
223
-
description: "Unfamiliar words and jargon are defined in a <a href='docapis_glossary_section.html'>glossary</a>. At times, the glossary terms are linked to their glossary definitions."
223
+
description: "Unfamiliar words and jargon are defined in a <a href='https://idratherbewriting.com/learnapidoc/docapis_glossary_section.html'>glossary</a>. At times, the glossary terms are linked to their glossary definitions."
224
224
225
225
- title: Glossary entries match the actual terms used in the content
226
226
description: "Glossary terms (as defined in the glossary) are actually used consistently across the documentation. For example, one doc set doesn't use a certain term while another uses a synonym of the term, with the admin UI using yet another term. If the glossary lists a term for a particular concept, the documentation content consistently uses that term."
Copy file name to clipboardExpand all lines: _docs/additional_resources/denver_workshop_recordings.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ These videos are from an API documentation workshop that I gave in Denver, Color
20
20
21
21
{% if site.format == "web" %}
22
22
23
-
{% include note.html content="For the most recent workshop recording, see the [Video recordings of API doc workshops](docapis_course_videos.html)." %}
23
+
{% include note.html content="For the most recent workshop recording, see the [Video recordings of API doc workshops](https://idratherbewriting.com/learnapidoc/docapis_course_videos.html)." %}
Copy file name to clipboardExpand all lines: _docs/additional_resources/docapis_aerisweather_example.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ In earlier tutorials, you integrated information from the [OpenWeatherMap API](h
26
26
27
27
## 1. Get the API keys
28
28
29
-
See the [Getting Started](http://www.aerisweather.com/support/docs/api/getting-started/) page for information on how to register and get API keys. (Get the free version of the keys available to development projects.) You will need both the ID and secret to make API calls. See [Get the Aeris Weather API secret and ID](docapis_get_auth_keys.html#aeris_weather_apikey) for more detail.
29
+
See the [Getting Started](http://www.aerisweather.com/support/docs/api/getting-started/) page for information on how to register and get API keys. (Get the free version of the keys available to development projects.) You will need both the ID and secret to make API calls. See [Get the Aeris Weather API secret and ID](https://idratherbewriting.com/learnapidoc/docapis_get_auth_keys.html#aeris_weather_apikey) for more detail.
0 commit comments