Description:
The successful candidate will be a hands-on user of our software platform & tools, and independently produce customer facing documentation that will cover the full range from low-level API's to architecture diagrams and how-to guides, including producing sample code to showcase the use of the API. Candidates should have solid software development experience as well as superior communication skills. This role will work, as part of our development, team to maintain and extend our developer portal (documentation.chartiq.com)
Specific Responsibilities
A Technical Writer must be able to communicate complex information clearly, concisely and accurately, and without relying on jargon. Your role involves tasks such as writing conceptual overviews and procedures, reading and writing example code, or updating help center queries and FAQs. As a Technical Writer at ChartIQ you will be a key link between Client Developers, ChartIQ Engineers, Product Managers, and Marketing.
- Design and organize documentation sets for new APIs and developer products.
- Create and organize internal technical information for developer processes, product features and new technologies.
- Create technical documentation for our open sourced products.
- Identify and propose solutions for major improvements to processes.
- Supplement documentation with relevant sample code and/or visuals needed to enhance the written word.
About You
- 5+ years experience writing documentation for developers (APIs, SDKs, web technologies) and other forms of technical content for software applications.
- You have tackled internal and external documentation projects that have made life easier for developers of all experience levels.
Technical Skills
- You are able to understand and then explain highly technical information leveraging a background in engineering or computer science in order to do this.
- You are comfortable with HTML and CSS; proficiency in a UNIX environment.
- You have previous experience with and know your way around wikis, blogs, and GitHub.
Communication and Teamwork
- You are able to take complex, technical information and translate it for colleagues and consumers who have nontechnical backgrounds.
- You ask the right questions and get the right details from highly technical and very busy people.
- You like to work cross-functionally with product managers, account managers, project managers and technical teams.
Motivated and Organized
- You are highly organized, self-motivated and love to bring order to chaos.
- You are a detail oriented person who can clearly state every step so that the instructions can be useful.
- You like to use your imagination to think about a procedure or product in the way that a person without technical experience would think about it.
- You have a natural curiosity for learning how things work.
- You’re not afraid of adjusting to changes midstream and are excited about using your creativity to solve problems.
- Bachelor’s degree in Technical Writing, Technical Communication, English or a related field