<meta http-equiv="content-type" content="text/html; charset=utf-8"><span class="Apple-style-span" style="font-family: arial, sans-serif; font-size: 13px; border-collapse: collapse; ">The ubuntu-manual guys have been very successful in getting screenshots<br>
into the docs. It's a lead that ubuntu-docs should follow, so long as we<br>don't go overboard and start (over-)using screenshots in inappropriate<br>places. I think we should work on cracking this particular issue once<br>
and for all this release cycle.</span><br>Hi,<div> <br><div>Can I give a +1 for use of images, one of the ones I was interested doing was installing LAMP, in the meantime, there are people having problems, the sooner a couple of simple screen-shots can be included the better. I was going to do a 1 hour presentation on it, except that it takes all of 10 minutes to do. </div>
<div><br></div><div>Yes, we do have to make allowances for those who do not have internet access speeds / limits to allow the downloading of many images, so we must bear those in mind. Can the docs team also have a look at Rule508 that does require an explanation is put into the <alt tag> ?</div>
<div><br></div><div><a href="http://www.section508.gov/index.cfm?FuseAction=content&ID=12#Web">http://www.section508.gov/index.cfm?FuseAction=content&ID=12#Web</a></div><div><br></div><div>That will, possibly drag all the documentation together.</div>
<div><br></div><div>I've cc'd this discussion to the accessibilty mailing list, as I have not seen any mention of it and I do think it is important that these needs are considered.</div><div><br></div><div>Just my $0.02</div>
<div><br></div><div>Regards,</div><div><br></div><div>Phill,</div><div><br></div><br><div class="gmail_quote">On Sun, Jun 13, 2010 at 12:16 AM, Phil Bull <span dir="ltr"><<a href="mailto:philbull@gmail.com">philbull@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">Hi guys,<br>
<br>
I'm back from my break now. Where did we get to with this discussion?<br>
Did the planned meeting occur, and if so, are there any logs that I can<br>
review?<br>
<br>
I'll reply to a couple of points that were made a while ago.<br>
<div class="im"><br>
On Tue, 2010-05-18 at 08:10 +0100, Matthew East wrote:<br>
</div><div class="im">> > Our team feels that there are some unaddressed gaps in Ubuntu<br>
> > documentation. For example, there is a lack of official linear<br>
> > documentation -- a guide, hence the UMP project's manual.<br>
><br>
> As I said quite early on in the last release cycle [1], I can see a<br>
> market for a single printable manual. We tend to make a clear<br>
> distinction in documentation writing between linear manuals and<br>
> onscreen help - they are two very different formats with separate<br>
> uses. But both of them have a place in helping users in different<br>
> contexts and situations. My problem with the manual team's work hasn't<br>
> been their goal of producing a single linear piece of documentation,<br>
> but rather it's been the fact that the team has sought to reinvent the<br>
> wheel by writing content from scratch, in circumstances where<br>
> ubuntu-doc's material was essentially suitable, with modification,<br>
> improvement and customisation, to being reused.<br>
<br>
</div>I agree that both linear and topic-based docs can be useful, but I don't<br>
think any of us have a good enough idea of where we should be using<br>
either of them. It's true that there are situations where one form of<br>
documentation is a more sensible choice than another. But are we<br>
actually choosing a documentation format because it's the right fit for<br>
a given situation, or just because we feel like using that particular<br>
format?<br>
<br>
I think we need to work harder on understanding our users' needs. I<br>
don't think statements like "I can see a market for X" or "there is a<br>
lack of Y" are helpful on their own - show me the evidence of a market<br>
for X, or the adverse impact of the lack of Y, please!<br>
<div class="im"><br>
> > There is<br>
> > still a lack of centrally-produced, localized documentation. There is<br>
> > very little visual aid in the docs, and no focus on multimedia.<br>
</div>[...]<br>
<div class="im">> As to the second sentence, we have discussed many times, most recently<br>
> in the past release cycle [2], the use of screenshots in the<br>
> documentation. My personal view tends to be that the difficulties of<br>
> arranging for translation of the screenshots (because it can't be done<br>
> through Rosetta) has meant that using them is undesirable. However, if<br>
> a way can be found to facilitate translation of screenshots, then that<br>
> may be a way to resolve the problem.<br>
<br>
</div>The ubuntu-manual guys have been very successful in getting screenshots<br>
into the docs. It's a lead that ubuntu-docs should follow, so long as we<br>
don't go overboard and start (over-)using screenshots in inappropriate<br>
places. I think we should work on cracking this particular issue once<br>
and for all this release cycle.<br>
<div class="im"><br>
> > We also felt that the Docs Team's process was somewhat rigid, and too<br>
> > slow for certain types of contributions. While this approach is very<br>
> > consistent with the docs team's emphasis on long-term sustainability<br>
> > and quality of the docs process, there was. in our view. much less<br>
> > emphasis on widening the scope of documentation and simplifying<br>
> > community input.<br>
><br>
> Lowering the barrier to entry and improving community input is<br>
> definitely a key goal of every Ubuntu team, including ubuntu-doc.<br>
> While we have made some progress towards (for example) encouraging<br>
> people to submit material in plain text, we've clearly not done enough<br>
> on this front. I think that ubuntu-manual has shown how to attract<br>
> contributors by using a lot of publicity and clear instructions about<br>
> how to contribute, and I think this is something that ubuntu-doc could<br>
> definitely learn from. I think the major problem is that the team<br>
> members frequently don't have much time to promote the team on blogs,<br>
> microblogs and websites, and equally sometimes potential new<br>
> contributors don't get as much attention and encouragement as they<br>
> deserve. ubuntu-manual's enthusiasm could help with that.<br>
<br>
</div>I can work on improving doc team "outreach" over the summer, because<br>
I'll actually have some free time over the next couple of months! I'll<br>
start a thread on this at some point.<br>
<br>
Thanks,<br>
<br>
Phil<br>
<font color="#888888"><br>
--<br>
Phil Bull<br>
<a href="https://launchpad.net/~philbull" target="_blank">https://launchpad.net/~philbull</a><br>
</font><div><div></div><div class="h5"><br>
<br>
<br>
--<br>
ubuntu-doc mailing list<br>
<a href="mailto:ubuntu-doc@lists.ubuntu.com">ubuntu-doc@lists.ubuntu.com</a><br>
<a href="https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc" target="_blank">https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc</a><br>
</div></div></blockquote></div><br></div>