From: Ricardo Wurmus <rekado@elephly.net>
To: Catonano <catonano@gmail.com>
Cc: Guix-devel <guix-devel@gnu.org>
Subject: Reference manual + tutorials (was: Customize GuixSD: Use Stock SSH Agent Everywhere!)
Date: Tue, 29 May 2018 16:57:17 +0200 [thread overview]
Message-ID: <87h8mqqzle.fsf@elephly.net> (raw)
In-Reply-To: <CAJ98PDzXBG+92iU=+uDncQVThi+v3rZpK9zwwzbfqaEV+BpMrA@mail.gmail.com>
Hi Catonano,
>> > In this regard, I'd lie to suggest this talk, I think it's relevant
>> > https://archive.fosdem.org/2017/schedule/event/legacy_docs/
>> >
>> > It'd be very useful for Guile too and God knows for how many more GNU
>> > projects
>>
>> Could you please summarize the key points and how they apply to this
>> discussion?
>>
>
>
> Sure ! Thanks for asking ! 😃
>
> I think a good starting point is this picture
> https://files.mastodon.social/media_attachments/files/003/855/604/original/b02a794729c184ad.png
[…]
Thank you for the summary!
I think that both styles are important. A reference manual is great
when looking up information and to figure out uncommon workflows. It’s
also good to have a single section that describes all features of a
tool, which otherwise would have to be extracted from user stories.
Having a document that is centered around user stories is also very
useful, as they make it easier for readers to see their own needs in
them and find the appropriate recipe that leads them to a solution more
quickly.
It would be great to have both! I’d like the existing reference manual
to remain as the canonical description of all features of Guix, so that
an additional story-centered document (whether that be a dedicated
section or a separate file) can guide readers to more information if
they might need it.
How to begin, though…? :)
--
Ricardo
next prev parent reply other threads:[~2018-05-29 14:57 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-26 15:23 Customize GuixSD: Use Stock SSH Agent Everywhere! Ludovic Courtès
2018-05-28 11:16 ` Pierre Neidhardt
2018-05-28 11:28 ` Ricardo Wurmus
2018-05-28 15:28 ` Joshua Branson
2018-05-28 15:31 ` Pierre Neidhardt
2018-05-29 12:51 ` Catonano
2018-05-29 13:42 ` Ricardo Wurmus
2018-05-29 14:35 ` Catonano
2018-05-29 14:57 ` Ricardo Wurmus [this message]
2018-05-29 15:14 ` Reference manual + tutorials (was: Customize GuixSD: Use Stock SSH Agent Everywhere!) Catonano
2018-05-29 15:19 ` Reference manual + tutorials Julien Lepiller
2018-05-29 15:30 ` Ricardo Wurmus
2018-05-29 19:38 ` Ludovic Courtès
2018-05-29 21:53 ` Ricardo Wurmus
2018-06-03 20:40 ` Ludovic Courtès
2018-05-28 20:11 ` Customize GuixSD: Use Stock SSH Agent Everywhere! Divan Santana
2018-05-31 10:47 ` Divan Santana
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87h8mqqzle.fsf@elephly.net \
--to=rekado@elephly.net \
--cc=catonano@gmail.com \
--cc=guix-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.