Skip to content

fredericosanntana/tech-writing-portfolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

Frederico Sanntana — Technical Writing Portfolio

Tech Writing Lead | Blockchain, Privacy & Zero-Knowledge Systems

Live Documentation Site | LinkedIn


What I Do

I write developer documentation for complex systems — blockchain protocols, zero-knowledge cryptography, and privacy-first architectures. My approach:

  • Developer-first: Every page answers a developer's question. If it doesn't, it doesn't ship.
  • Diagram-driven: Mermaid diagrams for every architecture decision. Text explains why; diagrams explain how.
  • Docs-as-code: Documentation lives in the same repo as code, goes through PR review, and deploys via CI/CD.
  • Terminology-rigorous: In ZK and privacy, one wrong term erodes trust. I maintain glossaries and style guides to keep language precise.

Documentation Samples

Sample Type Description
MCP Server API Reference API Reference REST API documentation with authentication, endpoints, request/response schemas, error codes, and rate limiting
System Architecture Architecture Guide 5-layer protocol architecture with Mermaid diagrams, layer descriptions, and data flow walkthrough
Zero-Knowledge Smart Contracts Smart Contract Docs ZK smart contract documentation covering privacy-by-design principles, Compact language, and contract registry
Documentation Standards Style Guide Writing standards covering voice, terminology, formatting, diagrams, and review checklists
Contributing Guide Developer Onboarding Contributor setup, repository structure, page creation workflow, and PR review checklist
Blockchain & Privacy Glossary Glossary Technical glossary covering ZK proofs, FHE, IPFS, DIDs, privacy regulations, and blockchain terminology

Docs-as-Code Pipeline

Document Description
Docusaurus Pipeline How I built and maintain the documentation infrastructure — tool selection, CI/CD, search, Mermaid support, and versioning

Tools & Workflows

Category Tools
Static Site Generator Docusaurus 3.x
Diagrams Mermaid (architecture flows, sequence diagrams, state machines)
Authoring Markdown, MDX, YAML frontmatter
Version Control Git, GitHub, branch-based review workflows
CI/CD Docker multi-stage builds, automated link validation, deploy pipelines
Search Algolia DocSearch integration
Linting markdownlint, custom terminology checks

Live Documentation Site

The samples in this repository are adapted from docs.dpo2u.com — the production documentation site for the DPO2U protocol. The site is built with Docusaurus 3.x and includes:

  • 20+ pages of technical documentation
  • Interactive Mermaid diagrams rendered natively
  • Full-text search via Algolia
  • Style guide and contributor workflow
  • Versioned API reference

Domain Expertise

Domain Experience
Blockchain Smart contract documentation (Solidity, Compact/Midnight), tokenomics, on-chain agent systems, ERC standards
Zero-Knowledge Proofs zk-SNARKs documentation, privacy-preserving protocol architecture, Midnight Network
Privacy Regulations LGPD (Brazil) and GDPR (EU) compliance documentation, data protection impact assessments
AI Agent Systems MCP (Model Context Protocol) server documentation, autonomous agent architectures, tool-use APIs
Decentralized Storage IPFS/Lighthouse integration documentation, content-addressed storage patterns
Fully Homomorphic Encryption OpenFHE integration documentation for computation on encrypted data

About This Repository

This portfolio demonstrates my technical writing across different documentation types. Each sample includes a context header explaining the project, target audience, and purpose.

All diagrams use Mermaid syntax and render natively on GitHub.


License

MIT

About

Technical Writing Portfolio — blockchain, zero-knowledge, privacy documentation samples

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors