Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

IA Guide - Initial Draft #3

Merged
merged 13 commits into from
Sep 20, 2020

Conversation

Loquacity
Copy link
Member

@Loquacity Loquacity commented Aug 31, 2020

## Writing for your readers
Now that you've had a think about who your readers are, and the kinds of things they might be using your documentation for, you can display them in a table like this:

<table>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you reckon this would translate well to Markdown or non-interactive mode?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way I see it, those fields just need to be blank for non-interactive mode. My thinking has been that we need to be able to just remove the interactive elements, and encourage use of a pen and paper.

@mgan59
Copy link

mgan59 commented Sep 16, 2020

Wanted to be able to review and understand more the approach here with Twinery. I took a shot at running this, let me know if this was the right approach or should I use some other client. Would be helpful to have more in-depth instructions on how this should run as it will help other maintain this for the future.

2020-09-16 06 38 53

Or should I breakup each section into passages? am I using even the correct client? Let me know if there is a specific client I should be using.

@Loquacity
Copy link
Member Author

Loquacity commented Sep 16, 2020

Wanted to be able to review and understand more the approach here with Twinery. I took a shot at running this, let me know if this was the right approach or should I use some other client. Would be helpful to have more in-depth instructions on how this should run as it will help other maintain this for the future.
Or should I breakup each section into passages? am I using even the correct client? Let me know if there is a specific client I should be using.

This is awesome! You just need to select chapbook as the format, so that the interactive bits work, I think.

@Loquacity Loquacity marked this pull request as ready for review September 20, 2020 02:26
@Loquacity
Copy link
Member Author

Merging this PR now that the initial draft is done. Will open a new PR for editing.

@Loquacity Loquacity merged commit fea0afb into thegooddocsproject:master Sep 20, 2020
camerons added a commit that referenced this pull request Dec 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants