alphagov / alphagov/tech-docs-template
[Enhancement]: Prototype different tech doc templates
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 84
- Forks
- 36
- Avg merge
- 10h 56m
- Merged PRs (30d)
- 2
Description
What should change?
The tech docs site is a it outdated, and it would be useful to have different layouts available for different needs
User need
We want to use this to test the assumption
Proposed solution
From a concerned and curious Tech Writer:
I've never used the prototype kit. Always seemed a bit over complicated. Can it turn the front page of the tech doc template to look like the front page of the gov wifi document site?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing tech docs template and the linked GOV.UK WiFi document site to understand the requested front-page style. Clarify which different layouts should be prototyped and how the assumption will be tested; done means the agreed layouts are available for evaluation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- design, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100