: Re: What are standard techniques that indicate to the documentation reader that they are to substitute their own appropriate text (e.g. username, domain)? When reading manuals or guides, I can easily

Depending on different operating systems/platform, the user is restricted to use special characters.

For example, Windows restricts to use special characters while creating a folder/file but Linux allows to use special characters to use naming a folder/file.

Documentation/manual for a software/platform is prepared by keeping all that in mind.

While researching to answer this I came across this beautiful software documentation document, it mentions

Documentation formats for user-entered commands or codes shall clearly
distinguish between literals (to be input exactly as shown) and variables
(to be selected by the user).

Load Full (0)

: What tips would you give to someone about to write a stage play? This is a broad and subjective question. However, I think it can be answered with advice such as: Don't include car chases,

@BetL639

Load Full 4 Comments

: A twist is a point in the plot of a story where what the reader has assumed to be true turns out to be false or incomplete. Use this tag for questions about how to write or handle twists,

@BetL639

Load Full 0 Comments

: How should I introduce multiple characters without it being repetitive? In my story, I have 8 characters I really want to focus on, which is already a pretty large cast to begin with. At the

@BetL639

Load Full 6 Comments

: Am I describing a zombie? I introduced a young person (called Raven) who the main character was friends with in my story; Raven is an excellent student who the main character is also teaching

: Re: What are standard techniques that indicate to the documentation reader that they are to substitute their own appropriate text (e.g. username, domain)? When reading manuals or guides, I can easily

More posts by @BetL639

: What tips would you give to someone about to write a stage play? This is a broad and subjective question. However, I think it can be answered with advice such as: Don't include car chases,

: A twist is a point in the plot of a story where what the reader has assumed to be true turns out to be false or incomplete. Use this tag for questions about how to write or handle twists,

: How should I introduce multiple characters without it being repetitive? In my story, I have 8 characters I really want to focus on, which is already a pretty large cast to begin with. At the

: Am I describing a zombie? I introduced a young person (called Raven) who the main character was friends with in my story; Raven is an excellent student who the main character is also teaching

Login to post a comment!

0 Comments

Back to top