ZUN UL NOOR

Case study — Independent

Zipped Docs

An independently developed WordPress documentation plugin, published on the WordPress Plugin Directory.

Type
Published WordPress plugin
Role
Sole developer — architecture, UI, security & publication
Stack
WordPress · PHP · JavaScript · REST API · Gutenberg

Context & problem

Zipped Docs turns WordPress into a full-featured documentation platform for product docs, knowledge bases, help centers, and developer documentation.

It began as internal tooling at Zip24 — migrating the team's documentation off Notion — and was then refined and published publicly on the WordPress Plugin Directory.

My responsibilities

  • Design the documentation content architecture: dedicated post types and hierarchical categories.
  • Build the reading experience: navigation rail, chapter engine, hierarchical table of contents, scroll-spy, breadcrumbs, and previous/next navigation.
  • Implement instant client-side search with REST API fallback and in-content highlighting.
  • Ship configurable settings, shortcode support, Gutenberg compatibility, and REST endpoints.
  • Harden the plugin for public release and publish it on WordPress.org.

Implementation & technical decisions

  • A precomputed documentation graph that reduces repeated dynamic queries.
  • Search layered for speed and resilience: instant client-side results with a REST API fallback.
  • Settings and shortcodes that let site owners shape the docs experience without code.
  • Security hardening throughout: nonce protection, input validation, sanitization, output escaping, and cleanup controls.

Challenges & trade-offs

  • Internal tooling and public product have different bars — publication required compatibility, settings surfaces, and security review beyond what an internal plugin needs.
  • Documentation UX lives in the details: scroll-spy accuracy, search relevance, and navigation state must all stay correct as content grows.

Outcomes & lessons

  • A publicly listed WordPress.org plugin: independent architecture, UI, security, and release work, end to end.
  • Proof of product thinking — an internal migration need developed into a releasable tool.