Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
cas741
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
W. Spencer Smith
cas741
Commits
4ae172ba
Commit
4ae172ba
authored
5 years ago
by
W. Spencer Smith
Browse files
Options
Downloads
Patches
Plain Diff
Updated checkpoints in the writing checklist, mainly for attention to detail
parent
1fd1764f
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
BlankProjectTemplate/docs/Writing-Checklist.pdf
+0
-0
0 additions, 0 deletions
BlankProjectTemplate/docs/Writing-Checklist.pdf
BlankProjectTemplate/docs/Writing-Checklist.tex
+23
-3
23 additions, 3 deletions
BlankProjectTemplate/docs/Writing-Checklist.tex
with
23 additions
and
3 deletions
BlankProjectTemplate/docs/Writing-Checklist.pdf
+
0
−
0
View file @
4ae172ba
No preview for this file type
This diff is collapsed.
Click to expand it.
BlankProjectTemplate/docs/Writing-Checklist.tex
+
23
−
3
View file @
4ae172ba
...
...
@@ -17,7 +17,7 @@
\begin{document}
\title
{
SRS
Checklist
}
\title
{
Writing
Checklist
}
\author
{
Spencer Smith
}
\date
{
\today
}
...
...
@@ -38,9 +38,12 @@
\begin{todolist}
\item
Only tex file (and possibly pdf files, or image files) are under version
control.
\item
Periods that do not end sentences for one space, like: ``I like Dr.
\
Smith.''
\item
Opening and closing ``quotes'' are used (
\verb
|
``quotes''
|
)
\item
Periods that do not end sentences are followed by only one space:
\verb
|
``I like Dr.\ Smith.''
|
, or for no linebreaks:
\verb
|
``I like Dr.~Smith.''
|
\item
Long names in math mode use either matit or text, or equivalent:
$
coeff
$
versus
$
\mathit
{
coeff
}$
versus
$
\text
{
coeff
}$
.
(
\verb
|
$coeff$
|
) versus
$
\mathit
{
coeff
}$
(
\verb
|
$\mathit{coeff}$
|
) versus
$
\text
{
coeff
}$
(
\verb
|
$\text{coeff}$
|
).
\end{todolist}
\item
Structure
...
...
@@ -48,6 +51,23 @@
\item
There is always some text between section headings
\item
There aren't instances of only one subsection within a section
\end{todolist}
\item
Spelling, Grammar and attention to detail
\begin{todolist}
\item
Each punctuation symbol (period, comma, semicolon, question mark,
exclamation point) has no space before it.
\item
Opening parentheses (brackets) have a space before, closing parentheses
have a space after the symbol.
\item
Parentheses (brackets) occur in pairs, one opening and one closing
\item
All sentences begin with a capital letter.
\item
Document is spell checked!
\item
Grammar has been checked.
\end{todolist}
\item
Writing style
\begin{todolist}
\item
Avoid sentences that start with ``It.''
\end{todolist}
\end{itemize}
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment