Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
6d2a371f
Commit
6d2a371f
authored
May 05, 2014
by
Larry Ullman
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Rough creation of a doc style guide
Should have started this before; important to maintain consistency.
parent
535be570
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
0 deletions
+28
-0
documentation_style_guide.md
docs/documentation_style_guide.md
+28
-0
No files found.
docs/documentation_style_guide.md
0 → 100644
View file @
6d2a371f
# Yii Documentation Style Guide
Guidelines to go by when writing or editing any Yii documentation.
*This needs to be expanded.*
## General Style
*
Try to use an active voice.
*
Use short, declarative sentences.
*
Demonstrate ideas using code as much as possible.
*
Never use "we". It's the Yii development team or the Yii core team. Better yet to put things in terms of the framework or the guide.
*
Use the Oxford comma (e.g., "this, that, and the other" not "this, that and the other").
*
Numeric lists should be complete sentences that end with periods (or other punctuation).
*
Bullet lists should be fragments that don't end with periods.
## Formatting
## References
*
Yii 2.0 or Yii 2 (not Yii2 or Yii2.0)
*
Each "page" of the guide is referred to as a "section".
## Capitalizations
*
Web, not web
*
the guide or this guide, not the Guide
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment