Menu

#10 Split vesta-intro for clarity

open
nobody
Man Pages (6)
5
2004-12-06
2004-12-06
No

The vesta-intro(1) man page currently serves several
different purposes:

- It has a few sections that are introductions that
explain important concepts (configuration files,
filename interpretation).

- It has a glossary that explains Vesta terminology.

- Its "See Also" section is a listing of many other man
pages and other documents users may need to refer to.

Unfortunately, this makes makes it easy for users to
overlook some of these different pieces. (For example,
one user requested an index of the man pages, and when
I asked them why the "See Also" section in
vesta-intro(1) wasn't sufficient, they said they'd
never noticed it, even though they had looked at the
man page.)

It might be best to break up the vesta-intro page into
three different man pages: an introduction, a glossary,
and an index of other documentation.

It might also be good to add more references to more
related man pages in the definitions of different terms
in the glossary, so that it can serve as more of a
topic index as well. (Many of the glossary entries
have such references now, but not all of them.)

Discussion


Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.