Sie sind auf Seite 1von 18

Guidelin

es to
solving
problem
s Ver 6.0

February 28

201
5

Solution authoring is the process of producing textbook


solutions for the text books available with Evelyn Learning
System. A Evelyn Learning System authored solution is
expected to be step by step and fully explained. It must help
the student learn how to solve the problem rather than just
give the answer.

Evelyn Learning
System Pvt.Ltd.

What is solutions authoring


Solution authoring is the process of producing textbook solutions for the text books
available with Pragmatum. A Pragmatum authored solution is expected to be step by
step and fully explained. It must help the student learn how to solve the problem
rather than just give the answer.

1. File setup
1.1 All solutions have to be created in MS Word 2003 format
only (.doc file). You might be using MS Office 2007 or 2010, but you can still save
the document as a Word 97-2003 document (*.doc) as shown below

P a g e |2

1.2 Each solution file should be named uniquely as:


<book ID>-<chapter number>-<problem number> .
For example, 253-2-2EP. In this example, the book ID is 253, the chapter number is 2,
and the problem number is 2EP. This has already been done for you in the blank files.
1.3 The first line of the first page of a solution file should have
the filename at the extreme left and the SA (Solution Authoring) code at the extreme
right of the page. The SA code made be 1112. There should be a blank line space both
before and after the first delimiter line on the top.
So the top line must be proper - question ID on left; AID: 1112 on the right;
followed by a blank line and then a single line followed by a blank line.
All this would have already been done for you.

The actual solution must be typed from the next line as shown above

P a g e |3

2. Margins and fonts


The page margins and paper size is only for your information. You do not have to
do anything about this. This has already been done in the blank files that are
given to you. This is why you must create the solutions in the blank files provided
ONLY.
2.1 The page margins (File->Page Setup->Margins) should be set as follows:
a. Top and Bottom: 1
b. Left and Right: 1.25
2.2 The paper size (File->Page Setup->Paper) should be as follows:
a. Page Height: 21 (inches)
b. Page Width: 8.5 (inches)
2.3 No content should spill into the margin portions of the
document (tables, graphs, images, text, etc.).
2.4 The font used should be: Times New Roman; Size: 12.
Even in the figures, where labelling and number lines/coordinates/any other text are
written, the font must be only 'Times new roman' and size 12
2.5 Colored, italic or bold text is not essential but can be
used for emphasis if required (However, equation numbers MUST be in
blue color only). The color chosen for highlighting should not overshadow the text
though.
2.6 Set line spacing to Single in the paragraph settings. At
the end of creating the solution, always do a select all and then do this in the
paragraph settings.

2.7 The default alignment option should be Justify (ctrl+J)


that would align text neatly along both the left and right margins.

3. Writing a solution
3.1 Do not skip steps. A solution broken down into steps is easiest to learn
and comes the closest to the classroom learning experience. Writing in steps is

P a g e |4

therefore the key to teaching effectively in this format. Provide necessary, relevant,
and related steps.
3.2 A step is a collection of closely related sentences or
calculations. Every solution should be broken down into steps. Delimiters should
be drawn so that the whole solution gets split into meaningful and easy-to-understand
steps.
3.3 A single line (delimiter) should be drawn after every step
(in MS Word, typing --- and hitting the Enter key will do this automatically). A
blank line each should be inserted above and below the delimiter.
3.4 Length of steps should never be more than half of a
page. If any step is very lengthy then we must split it suitably into two or more
steps. Start each of the split steps with a suitable sentence in order to make it studentfriendly.
3.5 If a question consists of multiple parts (e.g. (a), (b), (c)
), separate each part in the solution by drawing a double line as delimiter.
Use the method to insert delimiter, as described in Guideline 3.3, twice
to create a double delimiter
3.6 No delimiter is needed in the following two situations:
After the last step of a solution.
When a step ends at the end of a page and the next step starts on the
following page.

P a g e |5

3.7 Always review the worked out examples and notation


used in the textbook before beginning authoring. This is to ensure that only
the textbook methods or procedures or notation that the student is familiar with would
be used in your solution. For example, the italicization of the compounds, phases of
gases (l, aq, g, s, etc).
3.8 Take care of notations (e.g. c should not become C).
3.9 Every possible effort should be made to remove
punctuation errors and typos. Proper punctuations and typo-free
sentences make the learning experience smooth and easy for the student. Look out for
green underlines created by MS word automatically, which means that either you have
messed up on the grammar, or have extra space somewhere
3.10 Variables should be italicized everywhere in sentences,
equations, tables, diagrams.
Wrong Usage:
P a, b, c, d , e, f , g , h P, is not a lattice because f and g are upper bounds of

b, c and f and g are incomparable.


Correct Usage:

P a g e |6

P a, b, c, d , e, f , g , h P, is not a lattice because f and g are upper bounds of

b, c and f and g are incomparable.

3.11 Sketch a diagram or refer to any analogy in practical


experience to better explain a particular solution. If you are using an illustration,
make sure it is properly labelled and placed at the centre of the page.
Superscripts and subscripts should be regular, not bold or italic, and easily
distinguishable.
3.12 Every table/graph/diagram should be placed in the
centre of the page. A blank line should be inserted before and after every
table/graph/diagram. There must be a sentence/text before every table/graph/diagram.
In other words, a solution step should never start with a table/graph/diagram.
This is the incorrect way:-

The next figure shows how to get this right:-

P a g e |7

3.13 Applications to use to draw diagrams:


Diagrams are best drawn using CorelDraw. After pasting in the Word
solution document, save and retain the original CorelDraw file for
future corrections. The file of the drawing (with labelling telling about
the book, chapter number, and exercise and question number) must be
accompanied along with the submission. If you cannot draw using
Coreldraw, then snip/screen capture/take picture of the figure and paste
it in the word file at the required place and while submitting the
solutions, inform us the solutions numbers in which you have pasted
figures. We will get the figures drawn at our end.
For the simplest of diagrams, use the Diagram option in MS Word
itself. The various objects/shapes should be grouped together once
you finish drawing.
3.14 Equations should be typed using MathType software
ONLY. The recommended version to use is v 6.0 (on dropbox in the software folder).
Always align mathtype objects to the left margin of the word document. An equation
should always be preceded by a sentence. In other words, a solution step should not
start with an equation.
3.15 A single line should not contain more than one
equals sign in case of complex equations as in the example below.
10 x 5 5 x 2 x 7 3 x 7
The correct format is:
10 x 5 5 x 2 x 7
3x 7
3.16 The = signs should be aligned vertically when the left hand
side remains unchanged while you simplify the right hand side. There is an option for
aligning = signs in MathType.
For example:
10 x 5 5 x 2 x 7
10 x 3 x 7 5
7 x 12
12
x
7
3.17 Check that the units are written using Text format and
not Math format (when equations are written using MathType).
Example: When we have an equation of the form: W mggcm / s 2
Using text format for the units makes them easily distinguishable: W mg g.cm/s 2
3.18 You can type multiple lines of simplification in a single
MathType object. The number of lines/steps in a single MathType object
P a g e |8

should not exceed 4. A MathType object should not spill into the page margins. To
ensure this does not happen, it is recommended that the width is kept within 6
inches. This dimension can be verified by using the top side ruler in MathType.
Incorrect:
10 x 5 5 x 2 x 7
10 x 3 x 7 5
7 x 12
12
x
7
x 1.71
Correct:
10 x 5 5 x 2 x 7
10 x 3 x 7 5
7 x 12
12
x
7
x 1.71

P a g e |9

3.19 Every mathematical expression should be typed using


MathType in Math format itself so that the entire solution will have the same kind
2
of expression format. Even a small expression like f x x
However, for single variables that are mentioned in a sentence, MathType need not be
used.
3.20 Parentheses in MathType:
While typing in MathType, do not use keyboard to insert parentheses
or brackets
For inserting parentheses or brackets in MathType, use only the library
available in MathType itself

3.21 Chemical structures should be drawn using


ChemDraw/ChemBio only. Please retain the original ChemDraw/ChemBio files

P a g e | 10

with you for corrections or revisions that may become necessary after solutions are
reviewed. The software setup is on dropbox (in the software folder).
Chemical compound formulae (like C 2 H 6 etc ) must be written using
Mathtype only.
sunlight 6CO 2 6H 2O ) must be
Chemical equations (like C6 H12 O6 9O 2
written using Mathtype only.
Chemical structures and diagrams (like the ones shown below) must be made
using Chemdraw only. As you can see, the following figure has crooked lines:
H

H2N

H3C

CH

OH

H2C
(CH2)3

CH3
Valine

Lysine

NH2

H2N

H3C

CH
CH3

OH

CH2
(CH2)3
NH2

This has to be corrected to look more neat as shown below:

P a g e | 11

OH

H2O

H2N

H3C

CH

OH

OH

H2C
(CH2)3

CH3
Valine

Lysine

NH2

H2N

H3C

CH
CH3

OH

H2O

CH2
(CH2)3
NH2

3.22 Tables can be drawn using ONLY mathtype/word. Tabular


data needs to be given in tabular format itself.
Every table must have an appropriate title.
There must be a sentence/text before every table/graph/diagram. In other
words, a solution step should never start with a table/graph/diagram.
3.23 Numbering equations:
For numbering the equations, we need to follow the same format
everywhere in every solution
Equation numbers should never be typed within MathType along with
the equation.
Equation numbers should be typed within a pair of parentheses ( )
after six dots .
Equation numbers should be in a blue color only.
There must be sufficient spacing between the equations and their
numbers so that vertically aligning the equation numbers is possible.
Examples:
x2 y 2 0
x 2 y 2 z 2 2 xy 2 yz 2 xz 0

(1)
(2)

3.24 There must be a hypothesis at the beginning of each


solution. Hypothesis is briefly describing/stating, what is given and what is to be
found in the problem.

P a g e | 12

3.25 When there is a graph/figure given in the question, then


we need to make a rough sketch of the graph/figure in the solution also. Not the
exact replica, but a rough sketch. If the function is explicitly mentioned in the
question then you must draw using Maple. If only the sketch of the figure/graph is
there, then as a person solving the question, we understand that you might not be able
to draw the figures yourself. So we suggest that you snip the figure (i.e. take a
screenshot of the figure) and paste it in the word file. We will draw it. At the time of
submission, you will have to enumerate the question numbers for which you have
done so.
3.26 Sentences should be short, grammatically correct, and
easy to understand in one reading.
3.27 Phrases should not be used in place of sentences. Phrases
are short broken or incomplete sentences like:
Applying Pythagoras theorem
By using integration by parts
Applying chain rule
Applying sine rule
Division by 2
As in the last problem
As in problem 5
According to the figure in problem 7
3.28 Sentences should be conversational in tone. For example,
Add the values has a conversational tone, while The values are to be added does
not. The idea is to make it look like you are a teacher telling the student to do things
and making him walk through the solution. You are speaking to him and
telling/helping him with the solution.
Typically, the flow should be like this:
It is given in the problem that .
We have to find the ..
In the given statement, do .
Then take the numerator and do ..
Etc.
3.29 All variables must be properly explained when first
used in a solution.

P a g e | 13

3.30 Do not leave extra blank line gaps in the solution. As an


example:
It is given that ..
We will use the following function given
f x x

----------> this is an extra blank line gap


2

4. Dos
4.1 Every problem should be solved independently even if a
particular problem is the repeat of a preceding problem.
4.2 Always start every step with an opening sentence. If only
an equation or a diagram is going to be there in a step, put a sentence ahead of it to
make the step student-friendly.
4.3 Ampersand (&) and minus (-) should be avoided in text.
Instead, and and hyphen must be used in its place to make it more readable.
Always use the hyphen () instead of the smaller minus (-) sign throughout for all
purposes. Even in mathtype, ensure that the smaller minus sign is not formed while
creating expressions
4.7 While writing a series, avoid ----------, or . Instead use
(only
three dots usually called ellipsis also found in mathtype as a symbol)
Incorrect:

f x x

x3 x5 x7
x 2 n 1
2 n 1
1
3! 5! 7!
2n 1 !

Incorrect:

f x x

x3 x5 x7
x 2 n 1
2 n 1
................... 1
3! 5! 7!
2n 1 !

P a g e | 14

Correct:

f x x

x3 x5 x7
x 2 n 1
2 n 1
L 1
3! 5! 7!
2n 1 !

4.8 Box the final answer (in mathtype).


Example of a final answer that cannot be boxed: Tile is a better conductor of energy
than carpet
Examples of final answers that must be boxed:
x 2.3 km
Hence, the time required to achieve the speed of 60 mi/h will be 3.72 seconds
4.9 Single line spacing should be chosen in the paragraph
options. Also, the value of 0 pt must be set in the before and after options in
the paragraph options.

P a g e | 15

5. Donts
5.1 Do not copy the original question in the solution. Even
words like Solution. Or Soln. etc should not be there.
5.2 A table or a figure in the question in the book or in some
example in the book should not be referenced in the solution.
Instead, the table or figure should be created from scratch in the solution
5.3 Use of abbreviations like L.H.S., R.H.S., QED, F.T.C, CCW,
and w.r.t. should not be there.
5.4 Do not use dots in solutions for therefore () and
because (Q ). Use only therefore and because.
5.5 Usage of formulas, units, and constants: They should be
explicitly mentioned wherever possible. You should NOT be referring students to the
textbook to find the constants, formulas, etc.
Avoid phrases like:
* As in the last problem
* As in problem 5
* According to the figure in problem 7
5.6 Mixing of words and equations in a sentence:
We should not start any sentence with variables, numbers or equations
Example:
Incorrect: r is the radius of the circle.
Correct: The radius of the circle is r.
Try to separate out the big equations or expressions that come in
between the sentences (theorems, laws etc.), if possible.
2
However, we can ignore this for smaller functions like f x x

A small sentence giving a comparison like


When cost price > selling price then there is a loss
should be written as
When cost price is more than the selling price
A small declaration of a variable like
Let us suppose that the number of people living in Colorado=x
should be written as
Let us suppose that the number of people living in Colorado is x

5.7 Avoid copyrightable elements referenced in the original


problem.
(Do not use proper nouns like John, America, etc., while writing a solution.
Instead, use pronouns like he, the place, etc.)
Note: If there are two names America and Mexico, write A and M.
5.8 Do not approximate a value if it is to be used further in
calculations, as this will change the final answer.
P a g e | 16

5.9 Do not use dot where you have to use middot. For
example, the correct
usage is Nm (middot is used between Newton and meter), not N.m(dot is
used)
5.10 . There must not be extra blank lines between steps
and expressions in the solution

6. General stuff
6.1 Putting commas after every 3 digits counting from the
right is a must in international notation. It helps to instantly identify thousand,
million, billion, trillion, and so on (for example: 1,000,000 or 1,000,000,000).
In Pragmatum solutions, strictly dont use Indian system of lakhs, crores, etc. It is
wrong to use commas this way: 1,00,000 or 1,00,00,000.
6.2 If some sum of money is being talked about in a maths
problem, then we will use the comma delimiters to express millions or billions
when real life talk is being done about the money. But when that number will be taken
into an equation, then it becomes just a number (eg. $100,000 will become 100000 in
an equation). Also, the dollar amount is not to be written in the following forms:
50$
$50/50 million dollars
50 million $
The correct ways of writing the amounts in dollars:
$50
$50 million
6.3 Multiple choice questions: The solution to a multiple choice question
should have the explanation in sufficient detail for the correct choice. It is appropriate
in most cases to also explain why the wrong choices are wrong! Such additional detail
would help the student learn much more than just the theory/concept behind the
correct choice.

P a g e | 17

6.4 True and false type question: The solution to a true or false type
question should:
if true, have sufficient explanation on why it is true
if false, have sufficient explanation on why it is false and should also
touch upon the changes that would have made the answer true.
6.5 Lengthy solutions spanning more than one page
When solutions span multiple pages:
No step should be partially in one page and partially in the next. In such cases,
insert blank lines until the entire step jumps to the next page.
No delimiter is needed below the last step on a page.
Similarly no delimiter is needed above the first step on the next page.
No delimiter is needed below the last step of the multi-page solution.
7. Mathtype and Word Tutorials
7.1 Shortcuts in Mathtype:
3
Fraction Ctrl + f :
2
Square root Ctrl + r :

Integral sign Ctrl + i :

Box around some selected text Ctrl-Shift + t, x :


Change style to text style Ctrl-Shift + e
Change style to math style Ctrl-Shift + +

7.2 How to draw a table in Mathtype


Video tutorial: http://youtu.be/TbQ7mh6IuQg
7.3 How to set Text and Math styles
Video tutorial: http://youtu.be/Xq0EjHx7D8s
7.4 Paranthesis in Mathtype
Video tutorial: http://youtu.be/LTX_7oaEkVU
7.5 How to put a box around the answer in Mathtype
Video tutorial: http://youtu.be/2k9bjjBbcDw
7.6 How to align equations along the = sign in Mathtype
Video tutorial: http://youtu.be/XRERrFUyGOI
7.7 How to draw a delimiter line in MS Word
Video tutorial: http://youtu.be/DBc-bsSz7wI

P a g e | 18

Das könnte Ihnen auch gefallen