►
From YouTube: Tech writing: Documenting multiple fields
Description
This video shows an exercise for paring down information and documenting multiple UI fields at once.
Related style guide topic: https://docs.gitlab.com/ee/development/documentation/styleguide/#documenting-multiple-fields-at-once
A
So
today,
I'm
looking
at
the
admin
area
under
settings
repository
there's,
this
area
called
inactive
project
deletion,
and
the
idea
is
that
you
tell
it
hey
any
projects
that
are
bigger
than
this
size,
delete
them
after
this
amount
of
time
and
send
a
warning
email
after
this
amount
of
time
it's
a
little
bit
confusing
and
it
can
be.
The
UI
could
be
made
more
clear,
but
we're
just
going
to
talk
about
the
documentation.
A
A
It
started
to
discuss
the
actual
settings
that
are
in
the
UI,
so
delete
inactive
projects
is
the
check
box
and
then
the
other
ones
are
the
settings
underneath
that
check
box.
It
was
mixing
API
content
here.
These
are
API
endpoints
and
then
it
started
to
give
an
example
of
using
the
API,
which
you
can
also
do
in
the
UI,
and
then
it
had
some
tasks
that
are
actually
the
steps
for
how
you
would
get
to
that
area
of
the
UI
and
a
little
more
information.
A
So
when
we
started
working
on
this,
we
had
a
version
of
it
that
again
had
some
intro
text
concept
and
then
the
task
still
had
this
information
at
the
top
and
if
you're
trying
to
use
the
UI,
this
is
a
little
bit
out
of
order
in
a
way
delete.
Inactive
projects
is
actually
you
know
the
top
level
thing.
So
that
should
be
part
of
the
task
so
to
enable
this
thing
and
it
doesn't
have
to
be
configured
meaning
turn
it
on
or
off.
It's
just
turn
it
on.
A
We
just
want
people
to
come
here
turn
it
on.
You
could
do
a
separate
task
for
turning
it
off
if
you
really
wanted,
but
for
the
most
part
we
just
need
to
get
people
to
the
thing
to
turn
it
on,
and
then
we
can
give
them
a
little
more
information
about
some
of
the
fields
if
it's
useful
or
interesting,
but
we
moved
those
UI
or
sorry.
We
moved
the
little
API
strings
that
were
here.
A
A
So
but
back
to
this
task,
we
got
to
this
thing
where
it
says,
configure
the
necessary
options.
Well,
at
that
point
it
doesn't
say
anything
about
the
necessary
options
or
about
the
options
at
all,
because
that
was
actually
up
here.
So
if
we
turn
this,
if
we
change
this
into
just
turning
this
thing
on,
we
tell
them
to
pick
that
checkbox
because
they
need
to
select
it.
Then,
when
we
looked
more
closely
at
these
settings,
the
minimum
size
projects
smaller
than
this
threshold.
A
Well,
if
you
look
at
this
just
as
inactive
projects
that
exceed
so,
the
language
is
trying
to
be
helpful,
but
it's
actually
not
adding
anything
and
in
fact
it
might
be
confusing
a
little
bit
so
and
also
if
the
UI
changes
it's
immediately
going
to
be
out
of
date.
So
we
don't
necessarily
need
to
reiterate.
A
So
just
to
show
you
the
final
version,
we
just
get
straight
into
it.
You
configure
it.
You
select
that
check
box,
you
configure
the
settings
and
then
we
it
did
give
them
a
little
bit
of
the
remaining
useful
information
that
was
nested
in
that
top
section.
And
then
we
change
the
example
to
be
about
the
UI,
so
I
wanted
to
provide
you
with
this
link
to
the
style
guide.
It's
called
it's
under
the
navigation
section,
and
it's
about
documenting
multiple
fields
at
once.
A
This
is
probably
the
best
example
in
this
list
to
describe
multiple
fields.
Just
complete
the
fields
you
don't
have
to
tell
them
every
field,
but
if
there's
one
that
has
to
be
a
regular
expression
or
there's
one.
That
requires
a
certain
role.
Yes,
that's
great
to
call
out,
but
we
don't
need
to
call
out
everything
if,
if
it's
name
you
don't
have
to
say,
must
be
a
name
or
enter
a
name
for
branch
name,
it's
just
not
necessary.
So
hope
that
helps
you
in
some
way
and
thanks
for
listening.