http://ofbiz.116.s1.nabble.com/Re-svn-commit-r1653248-in-ofbiz-trunk-applications-humanres-data-helpdata-HELP-HR-xml-HELP-HR-main-xl-tp4662078p4662161.html
> Hi Adrian / Ron
>
> Thanks very much for the feedback.
>
> I was just trying to get back into updating the online help by doing a
> small commit first. I did enter a commit message but made a mistake on
> the text editor so it wasn't included. I immediately checked the
> commit and saw the commit message was missing so contacted Jacques,
> who helpful as always, added it for me.
>
> For the help pages themselves, I'm doing a copy and paste from Tom's
> original guide and found that a few of the docbook tags he used don't
> render at all in the content manager display so I was more focussed on
> getting it to display than the grammar. In future, I'll try to do at
> least a basic grammar check but I think it will be too difficult for
> me to do a full review at this stage.
>
> I think that getting the content pages into the online help structure
> is the most important. Once they are there, we can do full reviews of
> grammar, consistency, etc and anyone that does have any updates or
> corrections will be able to submit a patch.
>
> Thanks
> Sharan
>
>
> On 20/01/2015 22:48, Adrian Crum wrote:
>> Ron,
>>
>> It would have been less typing to make the changes on your local copy
>> and then submit a patch.
>>
>> Adrian Crum
>> Sandglass Software
>> www.sandglass-software.com
>>
>> On 1/20/2015 12:34 PM, Ron Wheeler wrote:
>>> I see a couple of grammar errors and some small quibbles about wording.
>>>
>>> "its" is the possessive
>>> "it's" is the contraction of "it is"
>>>
>>> "company's" is the possessive of company
>>>
>>> "Human Resource application (HR App)" and "the core to HR App" -
>>> inconsistent capitalization
>>>
>>> "the positions fulfillments" -> "the position's fulfillments" or "the
>>> positions' fulfillments" (ambiguous 1 or more positions) or better
>>> "fulfillment of positions".
>>> "Fulfill" is an action of hiring or promoting done by managers or HR
>>> professionals. "Fulfillment" is the completion of a hiring act.
>>> "Filled" or "occupied" describes the state of a position.
>>> "Incumbent" is the person who fills a position.
>>> Fill or Occupy is what a person does to a position.
>>>
>>> mixture of future and present tense makes the reading a bit difficult
>>> "Main window is the entry point" is followed by
>>> "screen will show" which should be "screen shows"
>>> (future makes it seem that this will only happen in a future release
>>> of the software. unless you add "When you click on X, the screen will
>>> show")
>>>
>>> full filled -> fulfilled
>>> See above
>>>
>>> The Company and departments under the Company can have children
>>> departments ->
>>> The Company and departments under the Company can have child
>>> departments
>>> "child" is an adjective and in English, adjectives don't get pluralized
>>> as they do in French or other languages!
>>>
>>> <para>There are three node types in the tree, each identified by a
>>> different icon. The top of the tree represents your Company, the
>>> highest level in the HR App organization. The Company and
>>> departments
>>> under the Company can have children departments or positions. Under
>>> positions are the people who fulfill the position.</para>
>>> starts by talking about node types and icons but then ignores the
>>> types
>>> and icons and discusses level.
>>>
>>> "Under positions are the people who fulfill the position."
>>> several issues - Mixture of singluar and plural.
>>> "The people who fill(occupy) the position are shown(or entered) under
>>> each position." might be better.
>>>
>>> "If the item is a position you can add a person to fulfill the
>>> position."
>>> Fulfill is a hiring or promotion activity in HR so it sounds like you
>>> are adding a person or persons who will hold that position in the
>>> future.(talent pool)
>>> I wonder if you just mean that you can add the person who occupies the
>>> position.
>>>
>>> Perhaps it might be helpful to establish a glossary of terms to use to
>>> describe navigation, tree structures, etc.
>>> This would help lead to a consistency in the description of things or
>>> actions that would help the user to be more certain about what each
>>> term
>>> or action actually mean.
>>>
>>> Sticking to a default tense when describing what the system does (or
>>> will do) also makes it easier to read.
>>>
>>>
>>> Ron
>>>
>>>
>>> On 20/01/2015 12:18 PM, Adrian Crum wrote:
>>>> Always include a commit log message please.
>>>>
>>>> Adrian Crum
>>>> Sandglass Software
>>>> www.sandglass-software.com
>>>>
>>>> On 1/20/2015 5:59 AM,
[hidden email] wrote:
>>>>> Author: sharan
>>>>> Date: Tue Jan 20 13:59:18 2015
>>>>> New Revision: 1653248
>>>>>
>>>>> URL:
http://svn.apache.org/r1653248>>>>> Log: (empty)
>>>>>
>>>>> Modified:
>>>>> ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR.xml
>>>>> ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR_main.xml
>>>>>
>>>>> Modified: ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR.xml
>>>>> URL:
>>>>>
http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR.xml?rev=1653248&r1=1653247&r2=1653248&view=diff
>>>>>
>>>>>
>>>>> ==============================================================================
>>>>>
>>>>>
>>>>> --- ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR.xml
>>>>> (original)
>>>>> +++ ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR.xml Tue
>>>>> Jan 20 13:59:18 2015
>>>>> @@ -22,5 +22,45 @@ under the License.
>>>>> xsi:schemaLocation="
http://docbook.org/ns/docbook>>>>> ../../../content/dtd/docbook.xsd"
>>>>> xmlns="
http://docbook.org/ns/docbook">
>>>>> <title>Human Resources Introduction</title>
>>>>> - <para>WIP, to be continued...</para>
>>>>> +
>>>>> + <title>About OFBiz Human Resources</title>
>>>>> + <para>The people who work for your company, it's human capital,
>>>>> are it's
>>>>> + most important asset. Selecting a software platform that
>>>>> increases the
>>>>> + value of your companies human capital and delivers benefits,
>>>>> services and
>>>>> + opportunities to your workforce, is critical to your companies
>>>>> success
>>>>> + .</para>
>>>>> +
>>>>> + <para>That platform must be able to accurately and reliability
>>>>> process
>>>>> + worker transactions, collect decision support information, and
>>>>> communicate
>>>>> + between management, workers and outside resources. The OFBiz
>>>>> Human
>>>>> + Resource application (HR App) can provide a backbone for
>>>>> building that
>>>>> + platform.</para>
>>>>> +
>>>>> + <para>In this chapter you are introduced to the organization of
>>>>> this
>>>>> + document and to the key business objects that are the core to HR
>>>>> + App.</para>
>>>>> +
>>>>> + <para>In the HR App you can:</para>
>>>>> +
>>>>> + <itemizedlist>
>>>>> + <listitem>
>>>>> + <para>Create positions</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Fulfill positions</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Define the responsibilities of a position</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Define a tree reporting structure between
>>>>> positions</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Track the positions fulfillments over time</para>
>>>>> + </listitem>
>>>>> + </itemizedlist>
>>>>> </section>
>>>>>
>>>>> Modified:
>>>>> ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR_main.xml
>>>>> URL:
>>>>>
http://svn.apache.org/viewvc/ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR_main.xml?rev=1653248&r1=1653247&r2=1653248&view=diff
>>>>>
>>>>>
>>>>> ==============================================================================
>>>>>
>>>>>
>>>>> --- ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR_main.xml
>>>>> (original)
>>>>> +++ ofbiz/trunk/applications/humanres/data/helpdata/HELP_HR_main.xml
>>>>> Tue Jan 20 13:59:18 2015
>>>>> @@ -22,11 +22,51 @@ under the License.
>>>>> xsi:schemaLocation="
http://docbook.org/ns/docbook>>>>> ../../../content/dtd/docbook.xsd"
>>>>> xmlns="
http://docbook.org/ns/docbook">
>>>>> <title>The Human Resources Main screen.</title>
>>>>> +
>>>>> +
>>>>> + <para>The Main window is the entry point into the HR App and
>>>>> displays the
>>>>> + Company tree view for navigating to key HR App items.</para>
>>>>> +
>>>>> <para> This screen will show the the organization of your
>>>>> company, the top level company is defined in a system setup file:
>>>>> general.properties.
>>>>> The system will list devisions and departments in the role
>>>>> "Internal organization" as defined in the party
>>>>> relationships
>>>>> as a "Group member" under it in as many levels as
>>>>> required.
>>>>> </para>
>>>>> +
>>>>> <para>
>>>>> related to an "Internal Organization" is an
>>>>> employee position which can be full filled by an employee in an
>>>>> employment.
>>>>> </para>
>>>>> + <title> Nodes In the Company Tree</title>
>>>>> +
>>>>> + <para>There are three node types in the tree, each identified
>>>>> by a
>>>>> + different icon. The top of the tree represents your Company, the
>>>>> highest
>>>>> + level in the HR App organization. The Company and departments
>>>>> under the
>>>>> + Company can have children departments or positions. Under
>>>>> positions are
>>>>> + the people who fulfill the position.</para>
>>>>> +
>>>>> + <title>Usage</title>
>>>>> +
>>>>> + <itemizedlist>
>>>>> + <listitem>
>>>>> + <para>Navigate the HR Organization to view departments,
>>>>> positions and
>>>>> + people</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Add or remove a department</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Add a person</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>Quickly open the profile of any item in the
>>>>> tree</para>
>>>>> + </listitem>
>>>>> +
>>>>> + <listitem>
>>>>> + <para>If the item is a position you can add a person to
>>>>> fulfill the
>>>>> + position</para>
>>>>> + </listitem>
>>>>> + </itemizedlist>
>>>>> +
>>>>> </section>
>>>>>
>>>>>
>>>>
>>>
>>>
>
>