Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

This section outlines fundamental style rules that apply to the Ed-Fi Academy material.

General

Primary Reference

The Ed-Fi Alliance uses the AP Style Guide as a base, with a few exceptions. The more glaring exceptions are noted herein.

Ed-Fi Style Guide

For technical and Ed-Fi Specific terms not covered herein, we use the /wiki/spaces/TECHPUB/pages/20612734 as a base. 

The article /wiki/spaces/TECHPUB/pages/20612742 contains guidance on Ed-Fi technologies, products, and services. The /wiki/spaces/TECHPUB/pages/20612743 contains common terms and usage.

In a fight between the Technical Documentation Style Guide and this document, this document wins for all Academy-related content.

Editing Scripts

Conversational Voice

The scripts will, of course, be spoken aloud. The Ed-Fi Alliance is going for a conversational tone, speaking as one might speak to a colleague or event attendee (as opposed to a formal lecture). 

In addition, this gives us license to use nontechnical language to discuss concepts, so long as the meaning is clear enough. 

Pause-for-Breath Comma

A note directed at editors: In the script text, it's useful to include commas to suggest a pause in speaking or a pause for breath in voiceover. So, err on the side of leaving commas inline, they may be intentional. 

  • No labels