VolunteerItemWriting: Difference between revisions

From LPI Wiki
Jump to navigationJump to search
No edit summary
Line 14: Line 14:


In case more than one answer is correct, we specify this by appending one of those brackets to the item:
In case more than one answer is correct, we specify this by appending one of those brackets to the item:
* (Choose <b>&lt;b&gt;TWO&lt;/b&gt;</b> correct answers.)
* (Choose <b>&lt;b&gt;THREE&lt;/b&gt;</b> correct answers.)
* (Choose <b>&lt;b&gt;FOUR&lt;/b&gt;</b> correct answers.)


* (Choose <b>TWO</b> correct answers.)
We do not mention the number in the question at any other place. For example, we won't ask "Which <b>&lt;b&gt;THREE&lt;/b&gt;</b> commands would...".
* (Choose <b>THREE</b> correct answers.)
* (Choose <b>FOUR</b> correct answers.)
 
We do not mention the number in the question at any other place. For example, we won't ask "Which <b>THREE</b> commands would...".


==Asking for commands and files in fill-in-the-blank items==
==Asking for commands and files in fill-in-the-blank items==
Line 30: Line 29:


When we ask for just a command we append the following to the question:
When we ask for just a command we append the following to the question:
 
* (Specify <b>&lt;b&gt;ONLY&lt;/b&gt;</b> the command without any path or parameters.)
* (Specify <b>ONLY</b> the command without any path or parameters.)


====Asking for full command including parameters====
====Asking for full command including parameters====


When we ask for a fluu command we append the following to the question:
When we ask for a fluu command we append the following to the question:
 
* (Specify the command without any path but <b>&lt;b&gt;INCLUDING ALL REQUIRED PARAMETERS&lt;/b&gt;</b>.)
* (Specify the command without any path but <b>INCLUDING ALL REQUIRED PARAMETERS</b>.)


===Asking for file and directory names===
===Asking for file and directory names===


When asking for a file or directory we either ask for the name or the full path and specify it by those appendices to the question:
When asking for a file or directory we either ask for the name or the full path and specify it by those appendices to the question:
 
* (Specify the file name only <b>&lt;b&gt;without any path&lt;/b&gt;</b>.)
* (Specify the file name only <b>without any path</b>.)
* (Specify the full name of the file, <b>&lt;b&gt;including path&lt;/b&gt;</b>.)
* (Specify the full name of the file, <b>including path</b>.)
* (Specify the <b>&lt;b&gt;full path&lt;/b&gt;</b> to the directory.)
* (Specify the <b>full path</b> to the directory.)


In all these cases we do not include such information in the answers itself.
In all these cases we do not include such information in the answers itself.
Line 52: Line 48:


When asking just for an option name:
When asking just for an option name:
* (Specify <b>ONLY</b> the option name without any values or parameters.)
* (Specify <b>&lt;b&gt;ONLY&lt;/b&gt;</b> the option name without any values or parameters.)
When asking for a variable name:
When asking for a variable name:
* (Specify <b>ONLY</b> the variable name without any values or operators.)
* (Specify <b>&lt;b&gt;ONLY&lt;/b&gt;</b> the variable name without any values or operators.)


===Asking for numbers===
===Asking for numbers===
Line 68: Line 64:


Within the IPv4 address space the following subnets are reserved for documentation purposes:
Within the IPv4 address space the following subnets are reserved for documentation purposes:
* 192.0.2.0/24 (TEST-NET-1)
* 192.0.2.0/24 (TEST-NET-1)
* 198.51.100.0/24 (TEST-NET-2)
* 198.51.100.0/24 (TEST-NET-2)
Line 76: Line 71:


For IPv6 the following prefix is reserved for documentation purposes:
For IPv6 the following prefix is reserved for documentation purposes:
* 2001:db8::/32
* 2001:db8::/32


ULAs and LLAs should only be used when we explicitly talk about them. Site-local addresses are deprecated and should not be used.
ULAs and LLAs should only be used when we explicitly talk about them. Site-local addresses are deprecated and should not be used.

Revision as of 16:36, 6 May 2014

Short Version

If you are feeling like you have a question that LPI should be asking, please read the item writing guide.

Then, head over to the LPI Item Contribution Tool and submitted (you do need an LPI ID to login).

Item Style Guide

In order to give our items a homogeneous appearance we created the following boilerplates and best practices which should be used in all items. There is however no guarantee that all items are formed as described herein.

Number of right answers in multiple choice items

In case only one answer is correct we do not mention anything about it as this is the default case.

In case more than one answer is correct, we specify this by appending one of those brackets to the item:

  • (Choose <b>TWO</b> correct answers.)
  • (Choose <b>THREE</b> correct answers.)
  • (Choose <b>FOUR</b> correct answers.)

We do not mention the number in the question at any other place. For example, we won't ask "Which <b>THREE</b> commands would...".

Asking for commands and files in fill-in-the-blank items

Asking for commands

We do not ask for the full path to the command s the candidate should specify the command name only. This is because locations may change and because full paths become long (which is hard in PBT) and offer more characters to get wrong.

Asking for single command names without parameters

When we ask for just a command we append the following to the question:

  • (Specify <b>ONLY</b> the command without any path or parameters.)

Asking for full command including parameters

When we ask for a fluu command we append the following to the question:

  • (Specify the command without any path but <b>INCLUDING ALL REQUIRED PARAMETERS</b>.)

Asking for file and directory names

When asking for a file or directory we either ask for the name or the full path and specify it by those appendices to the question:

  • (Specify the file name only <b>without any path</b>.)
  • (Specify the full name of the file, <b>including path</b>.)
  • (Specify the <b>full path</b> to the directory.)

In all these cases we do not include such information in the answers itself.

Asking for options and parameters

When asking just for an option name:

  • (Specify <b>ONLY</b> the option name without any values or parameters.)

When asking for a variable name:

  • (Specify <b>ONLY</b> the variable name without any values or operators.)

Asking for numbers

When asking for numbers the following appendix should be used:

  • (Specify the number using digits only.)

Using IP Addresses in Items

When talking about global IP addresses we use only IP addresses that are reserved for documentation purposes. We do not use IP addresses that are officially assigned to any party. Private addresses should only be used when we refer to their special semantics.

IPv4 addresses

Within the IPv4 address space the following subnets are reserved for documentation purposes:

  • 192.0.2.0/24 (TEST-NET-1)
  • 198.51.100.0/24 (TEST-NET-2)
  • 203.0.113.0/24 (TEST-NET-3)

IPv6 addresses

For IPv6 the following prefix is reserved for documentation purposes:

  • 2001:db8::/32

ULAs and LLAs should only be used when we explicitly talk about them. Site-local addresses are deprecated and should not be used.