VolunteerItemWriting - Revision history

FabianThorns: /* Asking for commands and files in fill-in-the-blank items */

2020-04-08T09:02:52Z

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

← Older revision		Revision as of 09:02, 8 April 2020
Line 92:		Line 92:
	When asking for numbers the following appendix should be used:		When asking for numbers the following appendix should be used:
	* (Specify the number using digits only.)		* (Specify the number using digits only.)

			===Asking for HTML elements===

			When asking for an HTML tag:
			* (Specify <b><ONLY></b> the opening tag without any options or contents.)

	==Using IP addresses and DNS names in Items==		==Using IP addresses and DNS names in Items==

FabianThorns: /* Terminology */

2018-10-30T23:39:27Z

Terminology

← Older revision		Revision as of 23:39, 30 October 2018
Line 10:		Line 10:
	When talking about exam development, the following terms are likely to be used:		When talking about exam development, the following terms are likely to be used:
	* „''Item''“ is an exam question including all provided answers for SC/MC items.		* „''Item''“ is an exam question including all provided answers for SC/MC items.
	* „''Single Choice''“ or „''SC''“ is an item that provides ~~four or~~ five answers from which one is correct.		* „''Single Choice''“ or „''SC''“ is an item that provides exactly '''five''' answers from which one is correct.
	* „''Multiple Choice''“ or „''MC''“ is an item that provides five answers from which ~~one to~~ three ~~is/~~are correct.		* „''Multiple Choice''“ or „''MC''“ is an item that provides exactly '''five''' answers from which two or three are correct.
	* „''Fill In The Blank''“ or „''FITB''“ is an item that is answers by a string and does not provide answers to choose from.		* „''Fill In The Blank''“ or „''FITB''“ is an item that is answers by a string and does not provide answers to choose from.
	* „''Stem''“ is the question part of an item.		* „''Stem''“ is the question part of an item.

FabianThorns: /* Asking for options and parameters */

2014-09-28T14:59:11Z

Asking for options and parameters

← Older revision		Revision as of 14:59, 28 September 2014
Line 85:		Line 85:
	When asking for a variable name:		When asking for a variable name:
	* (Specify <b><b>ONLY</b></b> the variable name without any values or operators.)		* (Specify <b><b>ONLY</b></b> the variable name without any values or operators.)
			When asking for an option's value:
			* (Specify <b><b>ONLY</b></b> the value without any option name, quotes or operators.)

	===Asking for numbers===		===Asking for numbers===

FabianThorns: /* Number of right answers in multiple choice items */

2014-08-23T11:35:33Z

Number of right answers in multiple choice items

← Older revision		Revision as of 11:35, 23 August 2014
Line 51:		Line 51:
	* (Choose <b><b>TWO</b></b> correct answers.)		* (Choose <b><b>TWO</b></b> correct answers.)
	* (Choose <b><b>THREE</b></b> correct answers.)		* (Choose <b><b>THREE</b></b> correct answers.)
	* (Choose <b><b>FOUR</b></b> correct answers.)

	Do not mention the number of correct answers in the stem. For example, "Which <b><b>THREE</b></b> commands would..." shouldn't occur, but plural may be necessary...		Do not mention the number of correct answers in the stem. For example, "Which <b><b>THREE</b></b> commands would..." shouldn't occur, but plural may be necessary...

FabianThorns: /* Line breaks */

2014-08-23T11:30:20Z

Line breaks

← Older revision		Revision as of 11:30, 23 August 2014
Line 229:		Line 229:
	daemon:x:2:2:daemon:/sbin:/bin/false</pre>		daemon:x:2:2:daemon:/sbin:/bin/false</pre>
	</pre>		</pre>

	~~==Line breaks==~~

	Line breaks may be used to give large stems some structure. As items should be as short as possible this should no often be the case! If -- after some intense rethinking the item -- it is necessary, <br /> tags are used for this purpose.

	=Hints for translators=		=Hints for translators=

GMatthewRice: /* How to use fixed font formating */

2014-08-22T13:12:32Z

How to use fixed font formating

← Older revision		Revision as of 13:12, 22 August 2014
Line 211:		Line 211:

	=== How to use fixed font formating ===		=== How to use fixed font formating ===
	Fixed font formatting can be done either inline using <tt>~~ttv~~>TT-Tags</tt></tt> or for whole paragraphs using		Fixed font formatting can be done either inline using <tt><tt>TT-Tags</tt></tt> or for whole paragraphs using
	<pre>		<pre>
	<pre>		<pre>

GMatthewRice: /* General rules for item writing */

2014-08-22T13:08:05Z

General rules for item writing

GMatthewRice: /* General rules for item writing */

2014-08-22T13:05:46Z

General rules for item writing

← Older revision		Revision as of 13:05, 22 August 2014
Line 31:		Line 31:
	* '''Create enough distractors.''' For SC/MC items, try to provide at least three, better four distractors and see to it, that they seem possible. If it is hard to find good distractors, consider changing the item to FITB or to retire it.		* '''Create enough distractors.''' For SC/MC items, try to provide at least three, better four distractors and see to it, that they seem possible. If it is hard to find good distractors, consider changing the item to FITB or to retire it.
	* '''Create plausible distractors.''' Instead of asking something completely irrational, obviously wrong or out of context, create distractors that sound plausible to someone trying to guess but must be unambiguous to an expert.		* '''Create plausible distractors.''' Instead of asking something completely irrational, obviously wrong or out of context, create distractors that sound plausible to someone trying to guess but must be unambiguous to an expert.
	* '''Create distractors of similar length.''' Distractors should vary in length too much. That prevents helping candidates to distinguish correct answers and foils.		* '''Create distractors of similar length.''' Distractors should not vary in length too much. That prevents helping candidates to distinguish correct answers and foils.
	* '''Ask for short and authentic answers for FITB items.''' Ask FIBT items only for text that would be entered exactly like that in a terminal. Never ask for verbal descriptions or other human language. Ask for example for single commands, programs, files or parameters but do not ask the candidate to complete a sentence by entering a noun.		* '''Ask for short and authentic answers for FITB items.''' Ask FIBT items only for text that would be entered exactly like that in a terminal. Never ask for verbal descriptions or other human language. Ask for example for single commands, programs, files or parameters but do not ask the candidate to complete a sentence by entering a noun.
	* '''Be comprehensive for FITB answers.''' When several answers are possible for a FITB item, provide all of them, each as an own correct answers.		* '''Be comprehensive for FITB answers.''' When several answers are possible for a FITB item, provide all of them, each as an own correct answers.

DImitriosBogiatzoules: /* Hints for translators */

2014-08-08T18:59:40Z

Hints for translators

← Older revision		Revision as of 18:59, 8 August 2014
Line 236:		Line 236:
	=Hints for translators=		=Hints for translators=

	Text that is formatted in ~~console~~ font may never be translated in any way. Though terms like <tt>at</tt> or <tt>date</tt> seem English, they always are “system language” are are universally valid. Editing those terms may easily change the sense of an item or break implications of the original wording. Translating text in fixed font may easily affect the correctness of the item!		Text that is formatted in fixed font may never be translated in any way. Though terms like <tt>at</tt> or <tt>date</tt> seem English, they always are “system language” are are universally valid. Editing those terms may easily change the sense of an item or break implications of the original wording. Translating text in fixed font may easily affect the correctness of the item!

	<b>This does however not mean that everything else may be arbitrary translated!</b> Translators must have appropriate technological knowledge in order to fully understand the item and to determine what to translate and what to keep. Also, translators must be familiar with the professional language and the technical terms used in the destination language. LPI exams should never be translated by non-technicians only.		<b>This does however not mean that everything else may be arbitrary translated!</b> Translators must have appropriate technological knowledge in order to fully understand the item and to determine what to translate and what to keep. Also, translators must be familiar with the professional language and the technical terms used in the destination language. LPI exams should never be translated by non-technicians only.

DImitriosBogiatzoules: /* Item formatting and markup */

2014-08-08T18:58:34Z

Item formatting and markup

← Older revision		Revision as of 18:58, 8 August 2014
Line 160:		Line 160:

	In general, items are written without any explicit formatting. There are however three exceptions:		In general, items are written without any explicit formatting. There are however three exceptions:
	* The <tt>~~console~~ font </tt>(or ~~fixed~~ font or monospaced font) must be used for terms that, when used in the context of the item, would be literally displayed on the system console.		* The <tt>fixed font </tt>(or console font or monospaced font) must be used for terms that, when used in the context of the item, would be literally displayed on the system console.
	* <b>Bold font</b> is used to point the candidate to important meta-information regarding the item.		* <b>Bold font</b> is used to point the candidate to important meta-information regarding the item.
	* In rare circumstances line<br />breaks may be added to the stem.		* In rare circumstances line<br />breaks may be added to the stem.
Line 176:		Line 176:
	Bold formatting is done by enclosing the bold term with the tags <b> and </b>.		Bold formatting is done by enclosing the bold term with the tags <b> and </b>.

	==~~Console~~ font formatting / „TT'ing“ ==		==Fixed font formatting / „TT'ing“ ==
	<br>		<br>

	<span style="color: red;">'''ATTENTION:'''</span> It is important to know that translators will not translate any text with ~~console~~ font format. It is therefore important to obey the following rules, to ensure that the item is working in every language!		<span style="color: red;">'''ATTENTION:'''</span> It is important to know that translators will not translate any text with fixed font format. It is therefore important to obey the following rules, to ensure that the item is working in every language!


Line 185:		Line 185:


	Everything that appears on a terminal is printed in ~~console~~ font when it is used in exactly the same way and context that would make it appear on a terminal. Everything else ~~must not be in console~~ font.		Everything that appears on a terminal is printed in fixed font when it is used in exactly the same way and context that would make it appear on a terminal. Everything else mustn't use fixed font.

	'''Note: Prompts are never shown in LPI exams. Avoid full console captures including a prompt, a command and the output of that command as this makes it hard for the candidate to determine what is input and what is output. Instead, create a question like 'In case the command <tt>foo</tt> leads to the following output: ...'.'''		'''Note: Prompts are never shown in LPI exams. Avoid full console captures including a prompt, a command and the output of that command as this makes it hard for the candidate to determine what is input and what is output. Instead, create a question like 'In case the command <tt>foo</tt> leads to the following output: ...'.'''
Line 210:		Line 210:
	* '''Abbreviations and acronyms''' like PCI, ACPI, LAMP are never formated in any special way.		* '''Abbreviations and acronyms''' like PCI, ACPI, LAMP are never formated in any special way.

	=== How to use ~~console~~ font formating ===		=== How to use fixed font formating ===
	~~Console~~ formatting can be done either inline using <tt>ttv>TT-Tags</tt></tt> or for whole paragraphs using		Fixed font formatting can be done either inline using <tt>ttv>TT-Tags</tt></tt> or for whole paragraphs using
	<pre>		<pre>
	<pre>		<pre>
Line 218:		Line 218:
	</pre>		</pre>

	tt-tags just put the string enclosed by them in ~~console~~ font. This is the usual way commands, files etc. are marked up in both the stem and the answers. If an answer contains just a command name, the full answer is enclosed in tt-tags.		tt-tags just put the string enclosed by them in fixed font. This is the usual way commands, files etc. are marked up in both the stem and the answers. If an answer contains just a command name, the full answer is enclosed in tt-tags.

	A pre-environment is used when the stem or the answers contain several following lines, like for example the output of a command or the content of a file. Within the pre-environment text is used literally, i.e. line-breaks within the pre-environment are shown as line breaks in the exam. Therefore the content of a pre-environment can be just put into it without any additional modification like e.g. without adding ~~attigion~~ <br /> tags.		A pre-environment is used when the stem or the answers contain several following lines, like for example the output of a command or the content of a file. Within the pre-environment text is used literally, i.e. line-breaks within the pre-environment are shown as line breaks in the exam. Therefore the content of a pre-environment can be just put into it without any additional modification like e.g. without adding <br /> tags.

	Note: When rendering an exam, <pre> and </pre> tags become a new, empty line. This should be avoided which is why the tags should be put on the first and the last line of the presented text and not on distinct lines. The following example illustrates this:		Note: When rendering an exam, <pre> and </pre> tags become a new, empty line. This should be avoided which is why the tags should be put on the first and the last line of the presented text and not on distinct lines. The following example illustrates this:

← Older revision		Revision as of 13:08, 22 August 2014
Line 26:		Line 26:
	* '''Use easy language.''' Use a homogeneous wording and avoid complex sentences.		* '''Use easy language.''' Use a homogeneous wording and avoid complex sentences.
	* '''Be specific.''' All correct answers must absolutely and in all circumstances fit the question. None of the distractors may not even eventually be considered correct no matter how.		* '''Be specific.''' All correct answers must absolutely and in all circumstances fit the question. None of the distractors may not even eventually be considered correct no matter how.
	* '''Be or not be.''' Each ~~answers~~ must be true or false without any consideration. Never ask for the “best” or “most likely” answer or use conditions like “could be” or “might be”.		* '''Be or not be.''' Each answer must be true or false without any consideration. Never ask for the “best” or “most likely” answer or use conditions like “could be” or “might be”.
	* '''Keep items simple.''' Do not provide unnecessary or anecdotal information.		* '''Keep items simple.''' Do not provide unnecessary or anecdotal information.
	* '''Begin with a W-word.''' To make the question clear to the candidate it is best to begin a ~~steam~~ with a W word like 'What' or 'Which'.		* '''Begin with a W-word.''' To make the question clear to the candidate it is best to begin a stem with a W-word like 'What' or 'Which'.
	* '''Create enough distractors.''' For SC/MC items, try to provide at least three, better four distractors and see to it, that they seem possible. If it is hard to find good distractors, consider changing the item to FITB or to retire it.		* '''Create enough distractors.''' For SC/MC items, try to provide at least three, better four distractors and see to it that they seem possible. If it is hard to find good distractors, consider changing the item to FITB or to retire it.
	* '''Create plausible distractors.''' Instead of asking something completely irrational, obviously wrong or out of context, create distractors that sound plausible to someone trying to guess but must be unambiguous to an expert.		* '''Create plausible distractors.''' Instead of asking something completely irrational, obviously wrong or out of context, create distractors that sound plausible to someone trying to guess but must be unambiguous to an expert.
	* '''Create distractors of similar length.''' Distractors should not vary in length too much. That prevents helping candidates to distinguish correct answers and foils.		* '''Create distractors of similar length.''' Distractors should not vary in length too much. That prevents helping candidates to distinguish correct answers and foils.
	* '''Ask for short and authentic answers for FITB items.''' Ask ~~FIBT~~ items only for text that would be entered exactly like that in a terminal. Never ask for verbal descriptions or other human language. Ask for example for single commands, programs, files or parameters but do not ask the candidate to complete a sentence by entering a noun.		* '''Ask for short and authentic answers for FITB items.''' Ask FITB items only for text that would be entered exactly like that in a terminal. Never ask for verbal descriptions or other human language. Ask for example for single commands, programs, files or parameters but do not ask the candidate to complete a sentence by entering a noun.
	* '''Be comprehensive for FITB answers.''' When several answers are possible for a FITB item, provide all of them, each as an own correct answers.		* '''Be comprehensive for FITB answers.''' When several answers are possible for a FITB item, provide all of them, each as an own correct answers.
	* '''Keep items short.''' Remember that the items should still fit into a 800x600 screen and that FITB answers must be written to the limited space of a PBT form.		* '''Keep items short.''' Remember that the items should still fit into a 800x600 screen and that FITB answers must be written to the limited space of a PBT form.
	* '''Don't reveal too much.''' The ~~steam~~ of an item should not disclose the answers to other questions.		* '''Don't reveal too much.''' The stem of an item should not disclose the answers to other questions.
	* '''Be urbane.''' Avoid cultural specifics, regional terminology and slang.		* '''Be urbane.''' Avoid cultural specifics, regional terminology and slang.
	* '''Be neutral.''' Never use judging adjectives. Do not let persons like „The system administrator“ appear and do something that could better be expressed as a neutral description of the resulting situation.		* '''Be neutral.''' Never use judging adjectives. Do not let persons like „The system administrator“ appear and do something that could better be expressed as a neutral description of the resulting situation.