minor change of workflow for beginners guide?
Hi Friends, I had initially started with proofreading for the new beginners guide, but quickly found it was very difficult to do, without taking the graphics into account. Without knowing where the images are going to be placed and whether they might have captions or not, it's hard to make the text fit well.
Especially when the goal is to be brief and clear with the text, and not load it with a lot of technical details. One way to make it simple, is to use graphics wisely. But if the graphic for a particular item is far away from the text on the page, it could backfire, and make it more difficult to understand.
I (or anyone) could proofread the text by itself. But after the layout and styling teams do their jobs, and place the images on the pages, the text and graphics may or may not work well together. Unless that's part of the style and layout teams' jobs? But it seems like that puts a lot of work on their plates?
So I want to propose doing the proofreading as the final step. I'm not familiar with writing books or manuals. But for general text documents, like articles or theses, it seems like proofreading is usually the final step. So I thought it couldn't hurt to make the suggestion.
I wasn't sure whether to make this an Issue in the gitlab. It seems like not very many of the Docs team or guide-writing team is looking there. So I wanted to at least start the discussion where the widest number of people can see it. If a formal Issue is needed, I'll be glad to make one.
Anyway, just a thought.
Thanks for listening, brynn
Maybe a good idea, but it can be wise to look briefely trough the text at this stage to fix some text issues. Hopefully the one who makes the illustrations don't have to do things twice.
Vennleg helsing
*Rei**dar Vik* Trostereiret Vik org.nr. 912 333 485 trostereiretvik.blogspot.com https://twitter.com/Trostereiret
2017-07-24 4:02 GMT+02:00 brynn <brynn@...78...>:
Hi Friends, I had initially started with proofreading for the new beginners guide, but quickly found it was very difficult to do, without taking the graphics into account. Without knowing where the images are going to be placed and whether they might have captions or not, it's hard to make the text fit well.
Especially when the goal is to be brief and clear with the text,
and not load it with a lot of technical details. One way to make it simple, is to use graphics wisely. But if the graphic for a particular item is far away from the text on the page, it could backfire, and make it more difficult to understand.
I (or anyone) could proofread the text by itself. But after the
layout and styling teams do their jobs, and place the images on the pages, the text and graphics may or may not work well together. Unless that's part of the style and layout teams' jobs? But it seems like that puts a lot of work on their plates?
So I want to propose doing the proofreading as the final step. I'm
not familiar with writing books or manuals. But for general text documents, like articles or theses, it seems like proofreading is usually the final step. So I thought it couldn't hurt to make the suggestion.
I wasn't sure whether to make this an Issue in the gitlab. It
seems like not very many of the Docs team or guide-writing team is looking there. So I wanted to at least start the discussion where the widest number of people can see it. If a formal Issue is needed, I'll be glad to make one.
Anyway, just a thought.
Thanks for listening, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Hi.
I agree. There should be a final proof read that will include everything and should make it easy for a beginner to follow but there are some text and grammar issues that needs to be sorted before then.
Thank you.
On Tue, Jul 25, 2017 at 12:17 PM, Reidar Vik <trostereiretvik@...2...> wrote:
Maybe a good idea, but it can be wise to look briefely trough the text at this stage to fix some text issues. Hopefully the one who makes the illustrations don't have to do things twice.
Vennleg helsing
*Rei**dar Vik* Trostereiret Vik org.nr. 912 333 485 trostereiretvik.blogspot.com https://twitter.com/Trostereiret
2017-07-24 4:02 GMT+02:00 brynn <brynn@...78...>:
Hi Friends, I had initially started with proofreading for the new beginners guide, but quickly found it was very difficult to do, without taking the graphics into account. Without knowing where the images are going to be placed and whether they might have captions or not, it's hard to make the text fit well.
Especially when the goal is to be brief and clear with the text,
and not load it with a lot of technical details. One way to make it simple, is to use graphics wisely. But if the graphic for a particular item is far away from the text on the page, it could backfire, and make it more difficult to understand.
I (or anyone) could proofread the text by itself. But after the
layout and styling teams do their jobs, and place the images on the pages, the text and graphics may or may not work well together. Unless that's part of the style and layout teams' jobs? But it seems like that puts a lot of work on their plates?
So I want to propose doing the proofreading as the final step.
I'm not familiar with writing books or manuals. But for general text documents, like articles or theses, it seems like proofreading is usually the final step. So I thought it couldn't hurt to make the suggestion.
I wasn't sure whether to make this an Issue in the gitlab. It
seems like not very many of the Docs team or guide-writing team is looking there. So I wanted to at least start the discussion where the widest number of people can see it. If a formal Issue is needed, I'll be glad to make one.
Anyway, just a thought.
Thanks for listening, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Thanks for your comments Reidar Vik and Jp Otto!
I'll make up an example of the problem I'm running into. Maybe easier to understand a concrete example.
I'll post it in the gitlab account though. https://gitlab.com/inkscape/inkscape-docs/manuals/issues/11
Thanks, brynn
-----Original Message----- From: Jp Otto Sent: Tuesday, July 25, 2017 4:40 AM To: Reidar Vik Cc: brynn ; Inkscape-Docs Subject: Re: [Inkscape-docs] minor change of workflow for beginners guide?
Hi.
I agree. There should be a final proof read that will include everything and should make it easy for a beginner to follow but there are some text and grammar issues that needs to be sorted before then.
Thank you.
On Tue, Jul 25, 2017 at 12:17 PM, Reidar Vik <trostereiretvik@...2...> wrote:
Maybe a good idea, but it can be wise to look briefely trough the text at this stage to fix some text issues. Hopefully the one who makes the illustrations don't have to do things twice.
Vennleg helsing
Reidar Vik Trostereiret Vik org.nr. 912 333 485 trostereiretvik.blogspot.com https://twitter.com/Trostereiret
2017-07-24 4:02 GMT+02:00 brynn <brynn@...78...>: Hi Friends, I had initially started with proofreading for the new beginners guide, but quickly found it was very difficult to do, without taking the graphics into account. Without knowing where the images are going to be placed and whether they might have captions or not, it's hard to make the text fit well.
Especially when the goal is to be brief and clear with the text, and not load it with a lot of technical details. One way to make it simple, is to use graphics wisely. But if the graphic for a particular item is far away from the text on the page, it could backfire, and make it more difficult to understand.
I (or anyone) could proofread the text by itself. But after the layout and styling teams do their jobs, and place the images on the pages, the text and graphics may or may not work well together. Unless that's part of the style and layout teams' jobs? But it seems like that puts a lot of work on their plates?
So I want to propose doing the proofreading as the final step. I'm not familiar with writing books or manuals. But for general text documents, like articles or theses, it seems like proofreading is usually the final step. So I thought it couldn't hurt to make the suggestion.
I wasn't sure whether to make this an Issue in the gitlab. It seems like not very many of the Docs team or guide-writing team is looking there. So I wanted to at least start the discussion where the widest number of people can see it. If a formal Issue is needed, I'll be glad to make one.
Anyway, just a thought.
Thanks for listening, brynn
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Well actually, nevermind. It looks like someone else has moved all the image from the bottom of the pages up into the text. So that problem is solved.
-----Original Message----- From: brynn Sent: Monday, July 31, 2017 12:20 PM To: Jp Otto ; Reidar Vik Cc: Inkscape-Docs Subject: Re: [Inkscape-docs] minor change of workflow for beginners guide?
Thanks for your comments Reidar Vik and Jp Otto!
I'll make up an example of the problem I'm running into. Maybe easier to understand a concrete example.
I'll post it in the gitlab account though. https://gitlab.com/inkscape/inkscape-docs/manuals/issues/11
Thanks, brynn
-----Original Message----- From: Jp Otto Sent: Tuesday, July 25, 2017 4:40 AM To: Reidar Vik Cc: brynn ; Inkscape-Docs Subject: Re: [Inkscape-docs] minor change of workflow for beginners guide?
Hi.
I agree. There should be a final proof read that will include everything and should make it easy for a beginner to follow but there are some text and grammar issues that needs to be sorted before then.
Thank you.
On Tue, Jul 25, 2017 at 12:17 PM, Reidar Vik <trostereiretvik@...2...> wrote:
Maybe a good idea, but it can be wise to look briefely trough the text at this stage to fix some text issues. Hopefully the one who makes the illustrations don't have to do things twice.
Vennleg helsing
Reidar Vik Trostereiret Vik org.nr. 912 333 485 trostereiretvik.blogspot.com https://twitter.com/Trostereiret
2017-07-24 4:02 GMT+02:00 brynn <brynn@...78...>: Hi Friends, I had initially started with proofreading for the new beginners guide, but quickly found it was very difficult to do, without taking the graphics into account. Without knowing where the images are going to be placed and whether they might have captions or not, it's hard to make the text fit well.
Especially when the goal is to be brief and clear with the text, and not load it with a lot of technical details. One way to make it simple, is to use graphics wisely. But if the graphic for a particular item is far away from the text on the page, it could backfire, and make it more difficult to understand.
I (or anyone) could proofread the text by itself. But after the layout and styling teams do their jobs, and place the images on the pages, the text and graphics may or may not work well together. Unless that's part of the style and layout teams' jobs? But it seems like that puts a lot of work on their plates?
So I want to propose doing the proofreading as the final step. I'm not familiar with writing books or manuals. But for general text documents, like articles or theses, it seems like proofreading is usually the final step. So I thought it couldn't hurt to make the suggestion.
I wasn't sure whether to make this an Issue in the gitlab. It seems like not very many of the Docs team or guide-writing team is looking there. So I wanted to at least start the discussion where the widest number of people can see it. If a formal Issue is needed, I'll be glad to make one.
Anyway, just a thought.
Thanks for listening, brynn
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
participants (3)
-
brynn
-
Jp Otto
-
Reidar Vik