Документирование, почему и как мы перешли к документации как концепции кода вместо тяжелого портала разработчиков, ориентированного на дизайн, для нашего продукта Payment Gateway.
ПОЧЕМУ?
Мы считаем, что есть разница между тем, как разработчики смотрят на вещи, и тем, как люди, не являющиеся разработчиками, смотрят на вещи.
Ниже приведены наши наблюдения, которые в основном справедливы для любой продуктовой компании:
- На товарном портале есть одна область, предназначенная для привлечения клиентов. (Владельцы бизнеса, управляющий директор и т. д.)
- И другая область для демонстрации того, как интегрировать этот продукт в существующий бизнес клиента. (инженеры / разработчики / группы интеграции и т. д.)
Десять лет назад, если вам удавалось привлечь пользователей пункта 1, вы были совершенно уверены, что продукт будет продаваться. Однако сейчас дело обстоит совершенно иначе. Стартапы растут, и пользователи категорий 1 и 2 в основном одинаковы, и угадайте, что: Если вам не удастся привлечь пользователей категории 2: высока вероятность того, что ваш продукт не будет продаваться из-за отсутствия простоты и ясности в интеграции.
В Paytm мы также ведем вертикаль, специально предназначенную для поощрения молодых талантов и начинающих предпринимателей к Строим для Индии. Вы можете следить за нами здесь, чтобы быть в курсе последних обновлений. Мы провели опрос на этом форуме и обнаружили, что большинству разработчиков было трудно следовать упомянутым там шагам. И мы провели больше опросов с нашими и другими разработчиками и позвонили, чтобы обновить нашу сеть разработчиков, чтобы решить эту проблему раз и навсегда.
КАК?
Наш новый портал для разработчиков построен на стеке JAM и следует принципу документации как кода. Ниже приведены наши основные ингредиенты:
1. Гэтсби
2. Файлы Markdown
3. i18n
4. Минималистичный дизайн
5. Открытый исходный код
Почему Гэтсби?
Следуя за стеком JAM, GraphQL, построенный на основе ReactJS, огромного и растущего сообщества разработчиков, созданного с использованием существующих и знакомых технологий веб-разработчиков. Ближайшей альтернативой, которую мы нашли в аналогичном стеке, был Docusaurus. Однако поддержка настроек, таких как боковые панели и т. Д., На данный момент (август 2018 г.) ограничена.
Почему файлы Md, а не HTML?
Идея состоит в том, чтобы в равной степени позволить разработчикам и не разработчикам участвовать в нашей сети. Любой может легко предложить или отправить PR для обновления нашей документации. Это поощряет чувство сопричастности, командную работу и постоянную обратную связь, в конце концов, ключ к совершенству.
Не забывайте, что мы планируем открыть исходный код нашего портала для разработчиков, чтобы каждый мог расширять и даже добавлять дополнительные страницы таким образом, чтобы упростить отслеживание и интеграцию.
Почему i18n?
Что ж, я не думаю, что мне нужно что-то здесь добавлять. :)
Почему минималистичный дизайн?
Потому что как разработчик, когда я попадаю на портал для разработчиков, меня больше интересуют четкие и четкие шаги, не отвлекаясь на высококачественную анимацию и визуальные эффекты. ПЛЮС у нас были подтверждающие данные для этого из опросов, которые мы проводили на нашем форуме Build for India.
Почему Opensource?
Разработчики - это сильная сторона любой компании. С помощью этого портала мы открываем каналы, по которым разработчики со всего мира могут внести свой вклад в постоянно растущее сообщество Paytm. Я считаю, что у каждого из нас есть уникальная идея в виде различных плагинов, каналов интеграции и т. Д., И, открывая наш портал для публики, мы делаем первый шаг к сотрудничеству. Вот наше репозиторий Git.
Не стесняйтесь сотрудничать!
Обратная связь?
Мы всегда открыты для инноваций и улучшений. Если у вас есть предложения по любому из наших продуктов, не стесняйтесь обращаться к нам, писать PR или сообщать об ошибке / улучшении.
За кадром
Я считаю, что инновации приходят автоматически, когда вами движет желание решать проблемы реального мира и отличная команда, которая разделяет ваше видение. Спасибо Шани, Мохиту, Адитье и Наману за воплощение этого видения в реальность.
Бесплатные вкусности
Мы создали простой стартовый пакет для всех, кто хочет запустить проект, используя вышеупомянутую техническую философию. Скачать здесь".
