Size: a a a

Технические писатели

2021 August 05

АШ

А Ш in Технические писатели
Кто-нибудь может подсказать, какие в Confluence есть возможности добавить на страницу текст, который будет виден только в режиме редактирования страницы?
Нужно в шаблоне страницы написать подсказки по заполнению полей.
Очевидное решение со вставкой элемента шаблона "Текст инструкции" не очень подходит - хотелось бы, чтобы подсказка в режиме редактирования оставалась и после того, как пользователь заполнил поле.
источник

АШ

А Ш in Технические писатели
Вариант со вставкой макроса "Свойства страницы" и установкой у него свойства "Скрытое" тоже так себе - подсказок нужно много, а макрос отображается очень некомпактно.
источник

АШ

А Ш in Технические писатели
Видел упоминания, что можно реализовать скрытие текста при отображении страницы с помощью стилей - но не разобрался, как
источник

A

Alex in Технические писатели
начальник оказался микроменеджером
источник

D

Daria in Технические писатели
Пишут

Use the Confluence Source Editor addon, edit the page, click the "<>" button and put the following code.
<ac:placeholder>This text will only be visible in edit mode
</ac:placeholder>
источник

АШ

А Ш in Технические писатели
Это эквивалентно вставке элемента шаблона "Текст инструкции", только более сложный путь
источник

A

Alex in Технические писатели
про биг дата – это такой речевой оборот. на пресс-конференции сказали, что анализировали активность по тачкам в клнфлюенс. в общем, сначала погрузитесь, сделайте факт-чек
источник

c

coffenot in Технические писатели
бывший военный, даже военный педагог полит... чего-то там
источник

НБ

Настя Бажанова... in Технические писатели
#wanted_tw

Company: Pleeco
Location: Saint-Petersburg // remote
Contact: @ooonastia

About Us

Pleeco is an engineering company on a mission to empower people to achieve more by using data and technology. We create innovative solutions that enable people to understand data and make their ideas actionable.

Pleeco Kelp is a no-code visual development platform where teams can collaborate to rapidly design, build, and share operational data-driven applications. By quickly stitching together data, APIs, and interface components into useful operational tools, people can do more and better work. We’ve done a lot with a little, but there’s much more work to be done. And we'd like your help.

Role

We are looking for a Technical Writer to produce high-quality documentation that contributes to the overall success of our products. You will join a team of talented engineers, designers and product managers who collaborate to make our products easier to use.

Responsibilities

- Work with internal teams to obtain an in-depth understanding of the product and the documentation requirements
- Produce high-quality documentation that meets applicable standards and is appropriate for its intended audience
- Write easy-to-understand user interface text, code annotations, online help and developer guides
- Create tutorials to help end-users use Kelp and a variety of sample applications build in Kelp
- Analyze existing and potential content, focusing on reuse and single-sourcing opportunities
- Create and maintain the information architecture

Requirements

- Proven working experience in technical writing of software documentation
- Ability to deliver high quality documentation paying attention to detail
- Ability to quickly grasp complex technical concepts and make them easily understandable in text and pictures
- Excellent written skills in English
- Strong working knowledge of Markdown and document publishing systems
- Basic familiarity with the SDLC and software development
- University degree in Computer Science, Engineering or equivalent preferred
источник

SR

Stas Rychkov in Технические писатели
Привет. Макросы Page Properties, Excerpt, Section --- любые, где есть флажок Hidden. Либо можно вставить макрос Markdown и внутри тэга <div class="my-hidden-block"> написать текст, а затем вставить блок  <style> и в нём отметить, что .my-hidden-block скрытый.


Lorem ipsum dolor sit amet, consectetur adipiscing elit.


// Hides the whole block
.my-hidden-block { display: none; }

или


// Text block will show as an empty block on default bckgnd
.my-hidden-block { color: transparent; }
источник

АХ

Алексей Хорьков... in Технические писатели
Есть ещё хорошая связка макросов, show if, hide if. Подзабыл правда как плагин именно называется, но думаю легко найдёте
источник

АШ

А Ш in Технические писатели
Думаю речь про него:
https://valiantys.com/en/blog/atlassian-administration/how-to-hide-certain-contents-of-a-confluence-page-from-or-show-them-to-users/
Но к сожалению инсталляция конфлюенса используется слишком многими, и вряд ли мне установят плагин.
источник

АШ

А Ш in Технические писатели
По Page Properties + флажок Hidden вариант так себе - подсказок нужно много, а макрос отображается очень некомпактно.
источник

АХ

Алексей Хорьков... in Технические писатели
Запросто, почему нет?) На всех это никак не повлияет. Пообщайтесь с админами) они только с виду нелюдимые, но всегда договороспособные
источник

SR

Stas Rychkov in Технические писатели
А! Ещё же есть заместитель, который можно отметить стандартным тэгом wiki-разметки.

Открываете режим редактирования страницы (клавиша E (eng layout)), открываете страницу в режиме разметки (макрос Source Editor), а после  текст:
<ac:placeholder>My hidden text
</ac:placeholder>
источник

SR

Stas Rychkov in Технические писатели
Ну несколько пикселей уберите через CSS.
источник

SR

Stas Rychkov in Технические писатели
источник

SR

Stas Rychkov in Технические писатели
источник

АС

Алексей Скорняков... in Технические писатели
#tw_wanted

Компания: ООО "НТЦ "АСКОР"
Местонахождение: Москва/Удалённо
Контакт: Алексей

Ищу ТехПиса для фрилансерской работы по одному заказу.

Суть - имеется система, достаточно большая, имеет в себе в разных пропорциях и масштабах функционал социальной сети, АСУ, системы электронного документооборота, платёжной системы и иной функционал. Написана на Java. По данной системе необходимо составить техническую документацию, достаточную для того  чтобы новый не знакомый с системой программист мог полностью в ней ориентироваться по данной документации.

Стоимость работы обсуждаема.
источник
2021 August 06

К

Катя Морозова... in Технические писатели
Здравствуйте! Подскажите, был ли у кого-то схожий кейс, или направьте меня в нужном направлении, пожалуйста 🙏
Есть репозиторий в гитхабе, в нем около 50 папок-сервисов, в каждом есть md файлы, где-то это ридми, где-то вообще ничего нет, где-то несколько. Также есть корневой ридми. Хочется инструмент для удобной работы с такой документацией: видеть, где что лежит, когда последний раз обновлялось, по возможности, редактировать. При этом не хочется весь репозиторий копировать себе.
Кто-нибудь находил подобное решение?
В целом, как адекватно работать с документацией в гитхабе?
источник