►
From YouTube: Session 1 Tech Writing Fundamentals
Description
Session 1 is an introduction to this class. More information:
https://about.gitlab.com/handbook/engineering/ux/technical-writing/fundamentals/
A
A
A
A
A
A
This
video
and
the
following
videos
cover
our
audience,
who
we
write
for
we're
going
to
do
a
brief
recap
of
what
you
covered
in
technical
writing,
1
pre-class
material,
and
then
we
will
dive
into
technical
writing
guidelines.
We'll
talk
briefly
about
testing
our
docs
or
linting,
and
we
will
talk
about
types
of
content.
We
call
this
ctrt
concepts,
tasks,
reference
and
troubleshooting
information,
and
our
last
section
we'll
talk
about
how
to
edit
for
ctrt.
A
So,
who
do
we
write
for
we
write
for
users
and
administrators
of
the
gitlab
product?
We
support
all
users
from
beginners
to
experts,
that's
a
ux
principle
at
gitlab,
and
to
do
this
we
write
clearly
simply
and
directly.
New
users
will
thank
you
for
clear
information
and
experts
will
scan
until
they
can
find
the
information
they
need.
A
A
A
We're
going
to
do
a
brief
recap
of
the
technical
writing
1
principles
that
we're
going
to
cover
in
later
videos,
the
ones
that
are
most
important
are
to
use
consistent
terms
to
use
active
voice,
to
write
in
present
tense,
to
use,
ordered
and
unordered
lists
and
to
use
parallelism
when
we
write
we're
going
to
go
into
detail
about
all
of
these
topics
later
and
review
various
other
grammar
rules.
So
join
me
in
the
following
videos
and
I'll
see
you
in
the
next.