Test assignment from Katkov Ivan

[Pseudolukian]

1. Strategy on improving Adapty documentation

I will divide the work on improving the documentation into two main blocks: content work and DocOps work. Content work on the documentation to enhance user experience:

• First, I will thoroughly study the Adapty documentation from start to finish. I’ll go through the key instructions as a regular user and test everything myself. If I find any confusing or unclear sections, I’ll fix them.
• I’ll analyze competitors’ documentation: RevenueCat, Qonversion, Apphud, Purchasely, and compare them with Adapty’s documentation. I’ll identify the strengths of each documentation, noting the most successful practices and approaches to apply them to Adapty’s documentation.
• I’ll conduct an SEO analysis of the existing Adapty documentation and competitors’ documentation using SEMrush, highlighting the most effective SEO patterns.
• I’ll develop an editorial policy through which I’ll apply the well-performing approaches and SEO insights found from competitors.
• I’ll review real user feedback: Adapty Feedback.

DocOps work to improve the documentation:

• Transition from a flat structure to a tree-like structure that logically mirrors the documentation’s TOC.
• Use #include and {{ var }} for content reuse, reducing errors, and ensuring greater consistency in the documentation.

2. Write documentation on the Overview feature

I rewrote the documentation in versioned_docs/version-3.0/overview.md, aiming to add more clarity and detail.

3. Identify issues with the SDK installation flow and provide an improved version

I worked a bit on versioned_docs/version-3.0/installation-of-adapty-sdks.md. Unfortunately, my laptop doesn’t allow me to fully install Dart, Swift, Flutter, and Android Studio to test the documentation comprehensively, so I did what I could for this task.

4. Identify issues with the Server Side API and (optionally, as a bonus) provide an improved version

Here, I already have some observations:

• Firstly, the documentation doesn’t clearly explain when to use api-secret-key versus public-api-key.
• Secondly, for some reason, the Postman section is nested inside the Requests section.
• Thirdly, there are duplicated 200 and 40X responses across the Requests pages.
• Fourthly, it’s generally unclear why this section is useful or how it can be applied. It lacks practical examples and an explanation of its value.

Overall, my impression of the documentation is mostly positive. It’s clear that the documentation is still young, and the value of many sections hasn’t been fully established yet. I hope I can be helpful, and that my experience and approach will contribute to making Adapty’s documentation even better.

[Pseudolukian]

Gh pages: https://pseudolukian.github.io/test_assignment_adapty/docs/
Overview: https://pseudolukian.github.io/test_assignment_adapty/docs/overview/
API: https://pseudolukian.github.io/test_assignment_adapty/docs/getting-started-with-server-side-api
SDK: https://pseudolukian.github.io/test_assignment_adapty/docs/installation-of-adapty-sdks