Skip to content

Commit 8b29571

Browse files
committed
rearrange the sections and added the information architecture section
1 parent 5eab107 commit 8b29571

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,6 @@ Below are some of the product documentation, where I have played a major role in
2020
* [Kubernetes Documentation](https://kubernetes.io/docs/home/)
2121
* [Civo Documentation](https://www.civo.com/docs)
2222

23-
## Glossaries
24-
25-
The Civo Kubernetes and Cloud-native glossary is out now. Check it out from [Kubernetes and Cloud-Native A-Z Guide](https://www.civo.com/blog/kubernetes-and-cloud-native-az-guide).
26-
27-
## E-Books
28-
29-
Coming Soon......
30-
31-
## Newsletters
32-
33-
* Written **52 Dev-Catch-Up issues** for [DevShorts](https://www.devshorts.in/archive?sort=new).
34-
3523
## Articles
3624

3725
The latest blog posts and articles are listed below:
@@ -76,6 +64,27 @@ The latest blog posts and articles are listed below:
7664
* [All you need to know about Internal Developer Platforms and architecting one with Backstage and Humanitec / Humanitec](https://docs.google.com/document/d/1MnJBgcBwsMaz3YoX77L8flNtWvruZrBifMAXOX8LUM4/edit)
7765
* [Kubernetes interview questions for beginners / Civo](https://www.civo.com/blog/kubernetes-questions-for-beginners)
7866

67+
## Glossaries
68+
69+
The Civo Kubernetes and Cloud-native glossary is out now. Check it out from [Kubernetes and Cloud-Native A-Z Guide](https://www.civo.com/blog/kubernetes-and-cloud-native-az-guide).
70+
71+
## Newsletters
72+
73+
* Written **52 Dev-Catch-Up issues** for [DevShorts](https://www.devshorts.in/archive?sort=new).
74+
75+
## Content Strategy and Information Architecture
76+
77+
**Case Study**: To create the information architecture and content strategy for a fictional company named Protekt and use a static site generator to show the created documentation structure.
78+
79+
**Work Done**: I created the **documentation structure** in accordance with the **developer journey** and used **Mkdocs with Material theme** as the static site generator. Since, this is a documentation which is catering mostly to developers, I structured the documentation in lieu of that. Although, some non-technical product managers can also access the documentation. Hence, the idea of putting references and concepts took place. I have added glimpses **on how a person can navigate through the documentation**. Alongside, I have mock-documented the introductory prose and a feature tutorial that shows the usage of Protekt's feature-specific SDK with multiple coding languages and frameworks. Furthermore, I **hosted the documentation** with the help of **GitHub workflows**.
80+
81+
**Protekt Documentation Plan**: Check out [Protekt Documentation Plan](https://docs.google.com/presentation/d/1090FK7MniRrgunvVw8I8aoFK6zLvi871oTa3HNyKYcs/edit?slide=id.p#slide=id.p).
82+
**Protekt Documentation**: Check out [Protekt Documentation](https://sayanta66.github.io/Mkdocs-hackmamba-assignment/).
83+
84+
## E-Books
85+
86+
Coming Soon......
87+
7988
## Upcoming articles:
8089

8190
* A step-by-step guide: Moving Your Applications to Kubernetes

0 commit comments

Comments
 (0)