Technical Writer for Flashloan System Documentation
We are looking for an experienced technical writer to create comprehensive and user-friendly documentation for our flashloan system, which is forked from Aave V3. While Aave V3's documentation is open source, we require original content that clearly explains our custom implementation, avoiding any direct cloning. The documentation will serve developers, integrators, and users, making it essential to explain both technical details and user flow in an easy-to-understand manner.
Responsibilities:
- Write clear, structured, and comprehensive documentation for the flashloan system.
- Ensure that the documentation covers all relevant aspects, including contract architecture, flashloan process, security measures, and integration guides.
- Highlight any custom features or differences from the original Aave V3 implementation.
- Collaborate with developers to ensure the accuracy and completeness of the technical details.
- Provide user-friendly guides for interacting with the flashloan system, including code examples, API references, and potential use cases.
Requirements:
- Proven experience in technical writing, especially in blockchain, DeFi, and smart contract systems.
- Deep understanding of Aave V3, including the flashloan mechanism.
- Ability to explain complex technical concepts in a clear and concise manner.
- Familiarity with Solidity, Ethereum, and decentralized finance protocols.
- Attention to detail and the ability to produce well-structured, original content.
- Experience working with developers and understanding smart contract documentation standards.
Preferred Qualifications:
- Experience with forking or customizing open-source DeFi protocols.
- Understanding of perpetual trading platforms, liquidity pools, and tokenization.
- Familiarity with Aave V3’s open-source documentation and the differences with our implementation.
Deliverables:
- Complete technical documentation covering every aspect of our flashloan system.
- Clear user guides with sample code for developers and integrators.
- Structured API documentation with examples.