Skip to content

Commit 0f63508

Browse files
authored
[Style Guide] How we video: minor issues (#27326)
1 parent c00265d commit 0f63508

File tree

5 files changed

+53
-30
lines changed

5 files changed

+53
-30
lines changed

src/content/docs/style-guide/how-we-docs/how-we-video/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ sidebar:
77

88
import { DirectoryListing } from "~/components";
99

10-
This page explains Cloudflares approach to integrating video into Cloudflares docs, covering topics from production to discoverability and long-term maintenance in a way that’s accurate, scalable, and AI-ready.
10+
This page explains Cloudflare's approach to integrating video into Cloudflare's docs, covering topics from production to discoverability and long-term maintenance in a way that is accurate, scalable, and AI-ready.
1111

1212
Our goal is to share practical workflows, tooling choices, and lessons learned to the open-source community so others can adopt or adapt the work without completely reinventing it.
1313

1414
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.
1515

16-
1716
<DirectoryListing />

src/content/docs/style-guide/how-we-docs/how-we-video/integration-in-docs.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ sidebar:
55
order: 3
66
---
77

8-
Our goal is to integrate video directly into the documentation so it accelerates the user experience and learning experience, not for videos to exist in a separate silo.
8+
Our goal is to integrate video directly into the documentation so it accelerates the user experience and learning experience, not for videos to exist in a separate silo.
99

10+
## Embed locations
1011

11-
## Embeding locations
1212
- Doc pages: We embed videos directly in the relevant pages. This gives users a comprehensive learning experience with visual context and accurate technical details.
1313
- [Video hub](https://developers.cloudflare.com/videos/page): For learners who prefer a video-first experience, we maintain a dedicated page for videos.
1414
- [Resources](https://developers.cloudflare.com/resources/): Video is a core content type in our system. You can filter specifically for videos in the resources page.
@@ -18,5 +18,6 @@ Our goal is to integrate video directly into the documentation so it accelerates
1818
We add time-stamped chapters to our videos to make relevant information more accessible by users and searchable by machines.
1919

2020
Chapters allow users to:
21+
2122
- **Skip ahead**: Jump directly to the specific information you need.
2223
- **Find answers**: Search engines and LLMs can index these chapters, making it easier to retrieve specific visual segments when a user asks a technical question.

src/content/docs/style-guide/how-we-docs/how-we-video/maintenance.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ sidebar:
77

88
Producing a video is just the beginning. Videos are inherently harder to edit than text, making maintenance more complex. Even small changes often require re-recording, re-timing, or adjusting visuals. This makes it critical to ensure script accuracy and alignment with documentation from the start.
99

10-
And since videos are harder to edit than text, ensuring script and visual accuracy upfront is critical. To keep videos up-to-date, we follow a simplified, two-pronged approach:
10+
To keep videos up-to-date, we follow a simplified, two-pronged approach:
1111

12-
- **AI-Assisted Periodic Checks**: Upload videos to Gemini for automated checks against documentation and dashboard UI
13-
Detect outdated workflows, UI elements, or inconsistencies
12+
- **AI-Assisted Periodic Checks**: Upload videos to Gemini for automated checks against documentation and dashboard UI.
13+
- Detect outdated workflows, UI elements, or inconsistencies.
1414

15-
- **Internal Feedback & Updates**: Rely on product managers (PMs), subject matter experts (SMEs), and internal signals when UI or functionality changes
16-
Update scripts, visuals, or narration as needed and re-upload the video
15+
- **Internal Feedback & Updates**: Rely on product managers (PMs), subject matter experts (SMEs), and internal signals when UI or functionality changes.
16+
- Update scripts, visuals, or narration as needed and re-upload the video.
1717

1818
We are currently developing an internal tool for code-driven screen demos. When product code updates, the tool automatically updates video footage, minimizing manual re-recording and ensuring tutorials and demos reflect the latest product state.
19-

src/content/docs/style-guide/how-we-docs/how-we-video/video-production-workflow.mdx

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ We follow a specific workflow and formatting specifications for our videos to en
1212
We use the following formatting specifications to uphold quality and consistency across our videos.
1313

1414
### Resolution
15+
1516
Videos should be recorded at 4K UHD. If 4K UHD is unavailable, Full HD footage may be accepted on a case-by-case basis. Footage below Full HD will not be used. Final video exports must be at least Full HD.
1617

1718
**Acceptable resolutions:**
19+
1820
- 4K Ultra HD: 2160p (3840x2160)
1921
- 2K Quad HD: 1440p (2560x1440)
2022
- Full HD: 1080p (1920x1080)
@@ -42,38 +44,44 @@ The most common screens and online platforms, such as YouTube and Vimeo, use a 1
4244
Social media platforms, like Instagram or Facebook, are typically accessed on mobile devices and usually require a 9x16 aspect ratio. Efficiency calls for a 1:1 aspect ratio, which works on all, but not as great.
4345

4446
### Subtitles
47+
4548
Subtitles are always published in English in SubRip format `.srt`.
4649

4750
**Guidelines for subtitles:**
51+
4852
- Maximum 45 characters per line.
4953
- Split over 2 lines when necessary.
5054
- Displayed for no longer than 10 seconds per subtitle.
5155

5256
### Music
57+
5358
To maintain a balanced audio mix:
59+
5460
- Music should be about 20dB lower than speaking volume.
55-
- Background music must be instrumental, ensuring it doesn't overpower the speaker.
61+
- Background music must be instrumental, ensuring it does not overpower the speaker.
5662

5763
## Preparation for your shoot
64+
5865
### Audio
5966

60-
**Microphone placement**: Clear and high quality audio is key to a good video. When setting up a microphone, it’s best to have it as close to the speakers as possible to capture clear audio, and out of the frame so you cannot see it in the footage.
67+
**Microphone placement**: Clear and high quality audio is key to a good video. When setting up a microphone, it is best to have it as close to the speakers as possible to capture clear audio, and out of the frame so you cannot see it in the footage.
6168

6269
- **Shotgun microphones**: Place the microphone over your head, just outside of the frame.
6370
- **Lavalier microphones**: Hide cords and cables, but the microphone can be visible.
6471

6572
**Background noise**:
66-
Choose a quiet and furnished room with soft surfaces to record your audio. Avoid locations with background noise and echo to the best of your ability. For example, avoid areas with fans, air-conditioning, and chatters, as these tend to get picked up by microphones.
73+
Choose a quiet and furnished room with soft surfaces to record your audio. Avoid locations with background noise and echo to the best of your ability. For example, avoid areas with fans, air-conditioning, and chatters, as these tend to get picked up by microphones.
6774

6875
:::caution[Beware of echoes]
69-
Echo is extremely difficult to remove in post-production. Avoid empty rooms, or soundproof your recording area with sound-absorbing materials such as carpets, curtains, blankets, or foam panels.
76+
Echo is extremely difficult to remove in post-production. Avoid empty rooms, or soundproof your recording area with sound-absorbing materials such as carpets, curtains, blankets, or foam panels.
7077
:::
7178

7279
:::note[Check for echoes]
73-
Clap your hands in the room, aim for a "dampened" sound.
80+
Clap your hands in the room, aim for a "dampened" sound.
7481
:::
7582

7683
### Presenter
84+
7785
**Frame**
7886

7987
When setting up the presenter frame, the presenter should position themselves in the center of the shot with some distance from the wall behind them to create depth. They should ensure their eyeline is directly towards the lens, engaging with the audience, and avoid any reflections on their glasses that could distract from the presentation. This will help maintain a clear and professional look throughout the video.
@@ -87,29 +95,32 @@ To create the most professional and consistent appearance, the Video Experience
8795
- Do not wear non-affiliated branded clothing, especially from non-open-source companies.
8896

8997
:::tip[Best practices]
90-
Follow your companys dress code guidelines and, when in doubt, stick to a solid color shirt.
98+
Follow your company's dress code guidelines. When in doubt, stick to a solid color shirt.
9199
:::
92100

93-
### Room Atmosphere
101+
### Room atmosphere
94102

95103
For the best video quality, consider the following options for setting up your space:
96104

97-
- Option A: Choose a location with natural light and minimal (echo)[/style-guide/video/#echo]. Add extra lighting if needed.
105+
- Option A: Choose a location with natural light and minimal [echo](/style-guide/video/#echo). Add extra lighting if needed.
98106
- Option B: Set up a green screen. Ensure proper lighting to minimize shadows for the cleanest background.
99107

100108
## Production
109+
101110
### AI-assisted video production
102111

103-
We use AI as a tool across our workflow to accelerate and remove friction in various production stages (scripting, voiceovers, animations, metadata, and review), not to fully automate. We elaborate on how we use AI in each production stage in the respective pages. Refer to [How we AI](/style-guide/how-we-docs/how-we-ai/) to understand more about our approach.
112+
We use AI as a tool across our workflow to accelerate and remove friction in various production stages (scripting, voiceovers, animations, metadata, and review), not to fully automate. We elaborate on how we use AI in each production stage in the respective pages. Refer to [How we AI](/style-guide/how-we-docs/how-we-ai/) to understand more about our approach.
104113

105114
### Topic selection
106-
We create videos strategically when it improves users' understanding of the written documentation. Refer to [Why and when we use videos](/style-guide/how-we-docs/how-we-video/why-and-when-we-use-videos/) to understand our approach to video content.
107-
We also consider page views, support tickets, and community feedback when selecting video topics. Our videos always map back to a specific documentation need and refer to written documentation as the source of truth.
115+
116+
We create videos strategically when it improves users' understanding of the written documentation. Refer to [Why and when we use videos](/style-guide/how-we-docs/how-we-video/why-and-when-we-use-videos/) to understand our approach to video content.
117+
We also consider page views, support tickets, and community feedback when selecting video topics. Our videos always map back to a specific documentation need and refer to written documentation as the source of truth.
108118

109119
### Script
120+
110121
Scripts are the blueprint for every video, guiding narration, on-screen text, and visual assets like animated illustration and diagrams. We use Cloudflare documentation as our source material to write scripts.
111122

112-
At Cloudflare, we use Gemini to accelerate script creation, followed by human review and editing the AI-generated draft to align with Cloudflares voice, accuracy requirements, and visuals. The high-level process looks like the following:
123+
At Cloudflare, we use Gemini to accelerate script creation, followed by human review and editing the AI-generated draft to align with Cloudflare's voice, accuracy requirements, and visuals. The high-level process looks like the following:
113124

114125
1. Generate initial script drafts based on an existing doc.
115126
2. Experiment with tone, style, and length of narration.
@@ -120,22 +131,27 @@ AI-generated scripts are starting points. Editing ensures factual correctness, a
120131
:::
121132

122133
### Voiceover
134+
123135
Voiceovers are an essential part of our video documentation workflow. They provide clarity, pacing, and engagement, complementing on-screen text and visuals. At Cloudflare, we leverage AI-assisted voice generation to streamline this process.
124136

125-
We use ElevenLabs, an AI voice generation tool, to produce natural-sounding voiceovers to:
126-
- Quickly hear how your script sounds in real time
137+
We use ElevenLabs, an AI voice generation tool, to produce natural-sounding voiceovers to:
138+
139+
- Quickly hear how your script sounds in real time.
127140
- Understand the cadence, timing, and clarity of narration
128141
- Speed up the stakeholder review process
129142
- Allows teams to create videos without a microphone
130143
- Supports early testing of pacing and integration with on-screen visuals
131144

132145
### Visuals
146+
133147
Visuals are the core of videos, providing context, reinforcing key concepts, and guiding the viewer through workflows. At Cloudflare, visuals include diagrams, animations, screen recording and talking head footage, all designed to complement the script and voiceover.
134148

135149
#### Diagrams
150+
136151
Diagrams are used to clarify complex concepts or show relationships that are difficult to convey through text alone. Diagrams are referenced in the script and visually timed to appear alongside the corresponding narration.
137152

138153
#### Animation
154+
139155
Animations bring diagrams and processes to life, helping users visualize dynamic workflows. Traditionally, creating animations involves keyframing, which requires specifying how objects move frame by frame. This is time-consuming and technical.
140156

141157
To speed up animation creation, we use AI:
@@ -145,15 +161,18 @@ To speed up animation creation, we use AI:
145161
- This approach allows motion graphics artists to focus on creative design rather than repetitive technical work.
146162

147163
#### Screen recording
164+
148165
We use screen recordings when demonstrating real product interactions by capturing UI-driven workflows directly from Cloudflare dashboards or developer tools.
149166

150167
Best practices:
168+
151169
- Highlight relevant UI elements with callouts or overlays.
152170
- Voiceover should match to guide the viewer through steps.
153171
- Make sure UI elements shown are up-to-date.
154172
- Blur sensitive data.
155173

156174
#### Talking head
175+
157176
We use talking head footage when a human presence adds clarity, engagement and warmth, such as:
158177

159178
- Introducing a workflow or video segment
@@ -167,33 +186,36 @@ Talking head footage is especially useful when voiceover alone cannot convey ton
167186
Every Cloudflare video undergoes a two-stage review process to ensure accuracy, clarity, and consistency with documentation standards. We leverage both human reviewers and AI tools to maintain high quality while enabling scalable production.
168187

169188
Scripts are reviewed before production to ensure:
189+
170190
- Technical accuracy – Explanations of concepts, workflows, and product behavior are correct.
171191
- UI and workflow accuracy – Steps described match the actual product.
172192
- Terminology alignment – Language matches Cloudflare documentation and branding.
173193

174194
Once a video is produced, it undergoes a visual review to verify:
195+
175196
- Illustration matches narration – Diagrams, animations, and callouts align with spoken content.
176197
- Diagram accuracy – Architecture and conceptual diagrams correctly reflect the product.
177198
- Screen recording accuracy – UI navigation, workflows, and system outputs are correct.
178199

179-
Cloudflare uses AI to enhance quality assurance by using saved prompts that remember your review preferences and focus areas, acting as a reviewer to ensuring consistent checks across projects:
200+
Cloudflare uses AI to enhance quality assurance by using saved prompts that remember your review preferences and focus areas, acting as a reviewer to ensuring consistent checks across projects:
180201

181202
- Immediate turnaround, even when human reviewers are unavailable
182203
- Reduces risk of errors and outdated information
183204
- Advanced image recognition supports maintenance by re-checking existing videos to see if UI or information has changed
184205

185-
186206
## Metadata and discoverability
187207

188-
Creating videos is only part of the story. To ensure our videos are findable, useful, and accessible, we apply structured metadata and AI-assisted tools to maximize discoverability for both human users and AI systems.
208+
Creating videos is only part of the story. To ensure our videos are findable, useful, and accessible, we apply structured metadata and AI-assisted tools to maximize discoverability for both human users and AI systems.
189209

190210
Before publishing, we generate rich metadata for each video:
211+
191212
- Title: Clear, descriptive, and aligned with documentation terminology
192213
- Description: Summarizes the content and context of the video
193214
- Chapters: Breaks the video into logical segments to improve understanding by AI
194-
- Transcripts and subtitles: Videos are hosted on Cloudflare Stream, we can generate captions automatically and download caption files `.vtt` as transcripts.
215+
- Transcripts and subtitles: Videos are hosted on Cloudflare Stream, we can generate captions automatically and download caption files `.vtt` as transcripts.
195216

196217
This enables:
218+
197219
- Search indexing
198220
- AI retrieval
199221
- Generative Engine Optimization (GEO)

src/content/docs/style-guide/how-we-docs/how-we-video/why-and-when-we-use-videos.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ sidebar:
88
We believe video is a powerful tool that complements documentation to help users quickly grasp complex concepts and workflows. Not every piece of documentation should be a video and we should use it intentionally. Our goal is to apply video where it adds clarity, reduces cognitive load, and improves task completion to the original documentation.
99

1010
We use video when it:
11+
1112
- Explains complex workflows
1213
- Demonstrates UI-driven actions
1314
- Reduces friction in onboarding and first-time use
1415
- Clarifies abstract or conceptual topics
1516

16-
We don’t use video for:
17+
We do not use video for:
18+
1719
- Reference material (API fields, parameters, limits)
1820
- Frequently changing UI or experimental features
1921
- Content that is faster to scan in text
20-
- Information users need to copy, paste, or search precisely
22+
- Information users need to copy, paste, or search precisely

0 commit comments

Comments
 (0)