Contributor Guide Chapter 3: some questions

There are two of them:

1) Several times in this chapter there is a link to another place in the chapter. It is followed by the following "on page x". The page number also links to same Set Reference. Do we really need the second link; do we really need to even have "on page x"?

2) In section, Submitting a chapter for review, the chapter is suppose to be uploaded to the Feedback folder. It has already been uploaded to the Draft folder in the section, Creating a completely new chapter step 3. Are we suppose to have a copy of this chapter in both folders?

Otherwise, I have almost completed my review.

Dan

Hi, Dan,

Great questions! I wanted to see if I could help, so here are my thoughts:

1) Due to inclusions of figures, etc., some of this chapter's sections
'fall' over several pages. I agree that perhaps having the page number
*and* the
title link might not be necessary in most cases; however, the one example
that stands out in my mind is "Creating a new chapter based on an existing
chapter" which is page 7, but the specific step which is repeatedly
referenced is step 5 on page 8.

2) I think this is a great question, because until now I never considered
that the draft which I'm downloading still exists in the Drafts folder.
Should there be a note in the Contributors' Guide to delete the Draft copy?
Who would have the 'authority' to delete that copy?

I hope these points are helpful,
Best,
Sam.

  Samantha Hamilton
  darling docs

  <https://darlingdocs.wordpress.com/> <https://github.com/samanthahamilton>
<https://www.linkedin.com/in/shamilton-64b4b71b0/>

Hej Dan,

There are two of them:

1) Several times in this chapter there is a link to another place in the chapter. It is followed by the following "on page x". The page number also links to same Set Reference. Do we really need the second link; do we really need to even have "on page x"?

I think both should remain; the link is meant for those reading the guide on an electronic device and therefore clocking on the link, brings the user to the right place. For those reading a hard copy, the page is the only reference which guides them.

2) In section, Submitting a chapter for review, the chapter is suppose to be uploaded to the Feedback folder. It has already been uploaded to the Draft folder in the section, Creating a completely new chapter step 3. Are we suppose to have a copy of this chapter in both folders?

Otherwise, I have almost completed my review.

Dan

Best regards

Leo

Comment inline:

Hi, Dan,

Great questions! I wanted to see if I could help, so here are my thoughts:

1) Due to inclusions of figures, etc., some of this chapter's sections 'fall' over several pages. I agree that perhaps having the page number /and/ the title link might not be necessary in most cases; however, the one example that stands out in my mind is "Creating a new chapter based on an existing chapter" which is page 7, but the specific step which is repeatedly referenced is step 5 on page 8.

Then "on page x" does serve a purpose, so this should be kept as is.

The problem part of what you wrote is in where the reader is taken when you control + click the a link. Both links will take the reader to page 7 not page 8. Furthermore, when right clicking either link and then selecting Edit Field from the context menu, a reference number is given among other things. These two links have the same reference number. The same thing is true for every sentence containing a link and the page it is found on. I really do not see a reason for the second link to be used unless it is changed to the actual location rather than to the heading above the actual location.

This raises another question. Why was the link to a heading instead of where the information is located?

Dan

Hi Dan and Team,

Apologies, but I suppose I'm now out of my depths on this one. The
references you're discussing were original in the documents when I
downloaded them as a draft. I simply added the step number to hopefully
highlight further, where to look in the text.

To Leo's point, I can absolutely see how keeping the page number is
important for hard copy reading.

Cheers,
Sam.

  Samantha Hamilton
  darling docs

  <https://darlingdocs.wordpress.com/> <https://github.com/samanthahamilton>
<https://www.linkedin.com/in/shamilton-64b4b71b0/>

Don't put yourself down like this. The only reason why I caught this was that I have been doing this for almost 20 years. Your adding the step number was something that needed to be done. I have now reviewed three chapters which you reviewed before me. I quickly noticed just how well you can spot things, seeming small things, that others would have passed over. This is the reason why your are a very valuable asset to our group. I am much stronger in doing the writing; you are much stronger in finding the little mistakes that we make.

On question #2: You made a very good point on this: the page number has to be included in the text.

Dan