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: src/content/docs/style-guide/api-content-strategy/index.mdx
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,17 @@
1
1
---
2
2
pcx_content_type: concept
3
-
title: API content strategy
3
+
title: API docs content strategy
4
4
sidebar:
5
5
order: 5
6
-
7
6
---
8
7
9
-
import { DirectoryListing } from"~/components"
8
+
import { DirectoryListing } from"~/components";
10
9
11
-
The API content strategy aims to:
10
+
The API docs content strategy aims to:
12
11
13
-
* Reduce internal and external user frustration
14
-
* Align with industry standards in terms of naming conventions and descriptions
15
-
* Create world-class content that is just as good, or better, than very popular API documentation
12
+
- Reduce internal and external user frustration
13
+
- Align with industry standards in terms of naming conventions and descriptions
14
+
- Create world-class content that is just as good, or better, than very popular API documentation
16
15
17
16
By ensuring Cloudflare's API content is straightforward, easy to navigate, and consistent, we can create world-class API content that eliminates user frustration and serves as an example of good API documentation.
Copy file name to clipboardExpand all lines: src/content/docs/style-guide/documentation-content-strategy/index.mdx
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,26 @@
1
1
---
2
2
pcx_content_type: concept
3
-
title: Developer documentation content strategy
3
+
title: Product docs content strategy
4
4
sidebar:
5
5
order: 3
6
-
7
6
---
8
7
9
-
import { DirectoryListing } from"~/components"
8
+
import { DirectoryListing } from"~/components";
10
9
11
10
The purpose of Cloudflare's developer documentation content strategy is to:
12
11
13
-
* Create and document standard templates to streamline content creation
14
-
* Document specific content types to help identify customers' specific needs
15
-
* Enable life cycle management to maintain and optimize a smaller set of pages
16
-
* Suggest easier navigation paths
12
+
- Create and document standard templates to streamline content creation
13
+
- Document specific content types to help identify customers' specific needs
14
+
- Enable life cycle management to maintain and optimize a smaller set of pages
15
+
- Suggest easier navigation paths
17
16
18
17
Strategically speaking, the mission and guiding principles translate into the following initiatives:
19
18
20
-
* Improve the entire ecosystem of customer-facing product content, placing major emphasis on consistency, quality, accuracy, and timeliness
21
-
* Create a cohesive and compelling story around our products and their functionality
22
-
* Develop content that increases product adoption, deflects support, and makes customers successful
23
-
* Partner with various internal departments and stakeholders in creating and sustaining a rich, consistent content experience across all Cloudflare products
24
-
* Devise new and better ways to give users the information they need, when and where they need it
19
+
- Improve the entire ecosystem of customer-facing product content, placing major emphasis on consistency, quality, accuracy, and timeliness
20
+
- Create a cohesive and compelling story around our products and their functionality
21
+
- Develop content that increases product adoption, deflects support, and makes customers successful
22
+
- Partner with various internal departments and stakeholders in creating and sustaining a rich, consistent content experience across all Cloudflare products
23
+
- Devise new and better ways to give users the information they need, when and where they need it
25
24
26
25
Adoption of this content strategy will be impacted by product releases, resourcing, and company goals.
This section shares how Cloudflare approaches docs strategically, covering topics like `how we built our site` and `how we think about redirects`.
11
+
12
+
The goal is twofold, because it:
13
+
14
+
- Encourages deep thinking about how we approach things (and if they could be better).
15
+
- Contributes back to the open-source ecosystem. We get a lot of benefits from being open source and we want to give back.
16
+
17
+
We hope you learn from the topics below. As always, [submit an issue](https://github.com/cloudflare/cloudflare-docs/issues/new) if you find something inaccurate or unclear.
0 commit comments