Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update information architecture #97

Merged
merged 7 commits into from
Oct 16, 2019
Merged

Update information architecture #97

merged 7 commits into from
Oct 16, 2019

Conversation

jonathanglassman
Copy link
Contributor

Context

Firebreak project to improve the docs information architecture

Changes proposed in this pull request

New information architecture, split into different stages of a project.

Guidance to review

Does this make sense?

Copy link

@bravegrape bravegrape left a comment

Choose a reason for hiding this comment

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

As per Show and Tell discussion, this is a much needed reorganisation of the docs for the tech docs tool ✨

How about shuffling some content around:

  • move 'Middleman options' under 'Amend your project'
  • break up 'Publish your documentation' into separate pages about deploying, hosting etc
  • move 'Page expiry and review' up one level to be the same level as 'Review your documentation'

Also sounds like 'Review your project' is more about reviewing docs so maybe worth renaming?

For the google docs marked 'requires permission to access' is there a specific reason we can't open up the useful content?

How about dropping 'amend' in favour of the more commonly used 'edit'? Here are some interesting insights from Google Trends: https://trends.google.com/trends/explore?date=all&geo=GB&q=amend,edit

Can we find a plan English alternative to 'Governance'?

I think it looks much, much better than the previous structure. I have a few suggestions - let me know what you think 😁

@jonathanglassman
Copy link
Contributor Author

As per Show and Tell discussion, this is a much needed reorganisation of the docs for the tech docs tool ✨

How about shuffling some content around:

  • move 'Middleman options' under 'Amend your project'
  • break up 'Publish your documentation' into separate pages about deploying, hosting etc
  • move 'Page expiry and review' up one level to be the same level as 'Review your documentation'

Also sounds like 'Review your project' is more about reviewing docs so maybe worth renaming?

For the google docs marked 'requires permission to access' is there a specific reason we can't open up the useful content?

How about dropping 'amend' in favour of the more commonly used 'edit'? Here are some interesting insights from Google Trends: https://trends.google.com/trends/explore?date=all&geo=GB&q=amend,edit

Can we find a plan English alternative to 'Governance'?

I think it looks much, much better than the previous structure. I have a few suggestions - let me know what you think 😁

Agree with your suggestions, however I'm a bit stumped as to why 'Page expiry and review' is not the same level as 'Review your documentation' - do you know? I'll make the other changes now.

Have 'Page expiry and review' at the same level as 'Review your 
documentation'
@bravegrape
Copy link

Agree with your suggestions, however I'm a bit stumped as to why 'Page expiry and review' is not the same level as 'Review your documentation' - do you know? I'll make the other changes now.

Fixed it by moving page-expiry.html.md.erb out into its own folder and renamed it to index.html.md.erb. The nested page implementation is a bit strange...

@jonathanglassman
Copy link
Contributor Author

Agree with your suggestions, however I'm a bit stumped as to why 'Page expiry and review' is not the same level as 'Review your documentation' - do you know? I'll make the other changes now.

Fixed it by moving page-expiry.html.md.erb out into its own folder and renamed it to index.html.md.erb. The nested page implementation is a bit strange...

Looks good, let me know what you think

Copy link

@bravegrape bravegrape left a comment

Choose a reason for hiding this comment

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

I think this looks good to merge 👍

@jonathanglassman jonathanglassman merged commit a7b2a65 into master Oct 16, 2019
36degrees added a commit to alphagov/tech-docs-template that referenced this pull request Nov 4, 2019
Fix a number of links from the README to the documentation which were broken in alphagov/tdt-documentation#97
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants