1 job found
- Our engineering team in Chicago needs a seasoned technical documentarian to translate complex code, architecture diagrams, and API endpoints into clear, concise, and user-friendly documentation. Think of it as being the bridge between the minds of our developers and the fingertips of our users. Your success isn't measured by lines of code written, but by how well you enable others to understand our technology. **Your Primary Responsibilities** * Craft comprehensive documentation for our suite of software products, including API references, user guides, tutorials, and troubleshooting guides. * Collaborate directly with software engineers, product managers, and UX designers to understand the product inside and out. * Maintain existing documentation to ensure accuracy and relevance as the product evolves. * Produce diagrams, flowcharts, and other visuals to enhance comprehension of technical concepts. * Contribute to the development of documentation standards and best practices within the organization. * Work closely with customer support teams to identify common questions and knowledge gaps among users, proactively addressing these gaps with clear and helpful documentation. * Create code examples in various programming languages to demonstrate the proper usage of our APIs. * Organize documentation using a consistent and intuitive information architecture, making it easy for users to find what they need. * Gather user feedback to continuously improve the quality and usefulness of our documentation. * Keep abreast of the latest technology trends and documentation tools, identifying opportunities to enhance our processes. **Necessary Experience** * Solid history in technical writing, with a portfolio of technical documentation samples. * Competency with documentation tools and content management systems. * Capability to understand and communicate complex technical concepts simply. * Superb written and verbal communication skills. * Experience in software development environments using multiple programming languages. * Deep working knowledge with markup languages like Markdown and reStructuredText, including associated tooling for publishing and formatting. * Background in source control using tools like Git and associated branching methodologies for documentation updates. * Familiarity with working on agile software teams, especially when sprints involve documentation deliverables. **What Makes You Exceptional** * Experience writing documentation for software developers, including API reference documentation and code samples. * Proficiency in creating visual aids, such as diagrams and flowcharts, to enhance understanding of complex concepts. * Contributions to open-source projects, whether through documentation, code, or issue tracking. **Compensations & Benefits** We believe in rewarding the talent and hard work that goes into crafting world-class technical documentation. Our contractor packages offers: * Competitive hourly rates reflective of your experience and expertise in the Chicago market. * Flexible work schedule, allowing you to balance personal commitments with project deadlines. * The opportunity to work on cutting-edge technologies in a rapidly growing software company. * Collaboration with a team of highly skilled engineers and product managers, fostering an environment of continuous learning. * Professional development opportunities to expand your technical writing skills and knowledge. This includes budget for tools and subscriptions needed to complete contracted work. * Direct impact on user experience, as your documentation plays a critical role in user understanding and adoption of our products.Chicago, ILOn-siteContractor/Freelance$60-$90/hourTechnical Writing12 days ago